org.opencms.ui.apps.user

Interface I_CmsOuTreeType

All Known Implementing Classes:

CmsOuTreeType

public interface I_CmsOuTreeType

Interface for OU tree types.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEmptyMessageKey() Returns the key for the empty-message.
CmsCssIcon	getIcon() Get the icon.
java.lang.String	getId() Gets the id of the type.
java.lang.String	getName() Gets the name of the element.
boolean	isExpandable() Checks if type is expandable.
boolean	isGroup() Checks if the tree type is group-like.
boolean	isOrgUnit() Checks if the tree type is OU-like.
boolean	isRole() Checks if the tree type is role-like.
boolean	isUser() Checks if the tree type is user-like.
boolean	isValidForOu(CmsObject cms, java.lang.String ou) Checks if the tree type is available for a given OU.
boolean	showInOuTable() True if type should be shown in OU overview table.

Method Detail

getEmptyMessageKey

java.lang.String getEmptyMessageKey()

Returns the key for the empty-message.

Returns:

key as string

getIcon

CmsCssIcon getIcon()

Get the icon.

Returns:

CmsCssIcon

getId

java.lang.String getId()

Gets the id of the type.

Returns:

id string

getName

java.lang.String getName()

Gets the name of the element.

Returns:

name

isExpandable

boolean isExpandable()

Checks if type is expandable.

Returns:

true if expandable

isGroup

boolean isGroup()

Checks if the tree type is group-like.

Returns:

true for group-like types

isOrgUnit

boolean isOrgUnit()

Checks if the tree type is OU-like.

Returns:

true for OU-like types

isRole

boolean isRole()

Checks if the tree type is role-like.

Returns:

true for role-like OUs

isUser

boolean isUser()

Checks if the tree type is user-like.

Returns:

true for user-like OUs

isValidForOu

boolean isValidForOu(CmsObject cms,
                     java.lang.String ou)

Checks if the tree type is available for a given OU.

Parameters:

cms - the CMS context

ou - the OU FQN.

Returns:

true if the tree type is valid for the OU

showInOuTable

boolean showInOuTable()

True if type should be shown in OU overview table.

Returns:

true if the type should be shown in the overview table for an OU