Package org.opencms.ui.apps.user
Enum CmsOuTreeType
- All Implemented Interfaces:
Serializable
,Comparable<CmsOuTreeType>
,java.lang.constant.Constable
,I_CmsOuTreeType
Type of element.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionReturns the key for the empty-message.getIcon()
Get the icon.getId()
Gets the id of the type.getName()
Gets the name of the element.boolean
Checks if type is expandable.boolean
isGroup()
Checks if the tree type is group-like.boolean
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, String ou) Checks if the tree type is available for a given OU.boolean
True if type should be shown in OU overview table.static CmsOuTreeType
Returns the enum constant of this type with the specified name.static CmsOuTreeType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
GROUP
Group. -
OU
OU. -
ROLE
Role. -
USER
User.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getEmptyMessageKey
Returns the key for the empty-message.- Specified by:
getEmptyMessageKey
in interfaceI_CmsOuTreeType
- Returns:
- key as string
-
getIcon
Get the icon.- Specified by:
getIcon
in interfaceI_CmsOuTreeType
- Returns:
- CmsCssIcon
-
getId
Gets the id of the type.- Specified by:
getId
in interfaceI_CmsOuTreeType
- Returns:
- id string
-
getName
Gets the name of the element.- Specified by:
getName
in interfaceI_CmsOuTreeType
- Returns:
- name
-
isExpandable
Checks if type is expandable.- Specified by:
isExpandable
in interfaceI_CmsOuTreeType
- Returns:
- true if expandable
-
isGroup
Description copied from interface:I_CmsOuTreeType
Checks if the tree type is group-like.- Specified by:
isGroup
in interfaceI_CmsOuTreeType
- Returns:
- true for group-like types
- See Also:
-
isOrgUnit
Description copied from interface:I_CmsOuTreeType
Checks if the tree type is OU-like.- Specified by:
isOrgUnit
in interfaceI_CmsOuTreeType
- Returns:
- true for OU-like types
- See Also:
-
isRole
Description copied from interface:I_CmsOuTreeType
Checks if the tree type is role-like.- Specified by:
isRole
in interfaceI_CmsOuTreeType
- Returns:
- true for role-like OUs
- See Also:
-
isUser
Description copied from interface:I_CmsOuTreeType
Checks if the tree type is user-like.- Specified by:
isUser
in interfaceI_CmsOuTreeType
- Returns:
- true for user-like OUs
- See Also:
-
isValidForOu
Description copied from interface:I_CmsOuTreeType
Checks if the tree type is available for a given OU.- Specified by:
isValidForOu
in interfaceI_CmsOuTreeType
- Parameters:
cms
- the CMS contextou
- the OU FQN.- Returns:
- true if the tree type is valid for the OU
- See Also:
-
showInOuTable
Description copied from interface:I_CmsOuTreeType
True if type should be shown in OU overview table.- Specified by:
showInOuTable
in interfaceI_CmsOuTreeType
- Returns:
- true if the type should be shown in the overview table for an OU
- See Also:
-