org.opencms.ui.apps.user

Enum CmsOuTreeType

java.lang.Object

java.lang.Enum<CmsOuTreeType>

org.opencms.ui.apps.user.CmsOuTreeType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsOuTreeType>, I_CmsOuTreeType

public enum CmsOuTreeType
extends java.lang.Enum<CmsOuTreeType>
implements I_CmsOuTreeType

Type of element.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GROUP Group.
OU OU.
ROLE Role.
USER User.

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.
static CmsOuTreeType	valueOf(java.lang.String name) 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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GROUP

public static final CmsOuTreeType GROUP

Group.

OU

public static final CmsOuTreeType OU

OU.

ROLE

public static final CmsOuTreeType ROLE

Role.

USER

public static final CmsOuTreeType USER

User.

Method Detail

values

public static CmsOuTreeType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CmsOuTreeType c : CmsOuTreeType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CmsOuTreeType valueOf(java.lang.String name)

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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getEmptyMessageKey

public java.lang.String getEmptyMessageKey()

Returns the key for the empty-message.

Specified by:

getEmptyMessageKey in interface I_CmsOuTreeType

Returns:

key as string

getIcon

public CmsCssIcon getIcon()

Get the icon.

Specified by:

getIcon in interface I_CmsOuTreeType

Returns:

CmsCssIcon

getId

public java.lang.String getId()

Gets the id of the type.

Specified by:

getId in interface I_CmsOuTreeType

Returns:

id string

getName

public java.lang.String getName()

Gets the name of the element.

Specified by:

getName in interface I_CmsOuTreeType

Returns:

name

isExpandable

public boolean isExpandable()

Checks if type is expandable.

Specified by:

isExpandable in interface I_CmsOuTreeType

Returns:

true if expandable

isGroup

public boolean isGroup()

Description copied from interface: I_CmsOuTreeType

Checks if the tree type is group-like.

Specified by:

isGroup in interface I_CmsOuTreeType

Returns:

true for group-like types

See Also:

I_CmsOuTreeType.isGroup()

isOrgUnit

public boolean isOrgUnit()

Description copied from interface: I_CmsOuTreeType

Checks if the tree type is OU-like.

Specified by:

isOrgUnit in interface I_CmsOuTreeType

Returns:

true for OU-like types

See Also:

I_CmsOuTreeType.isOrgUnit()

isRole

public boolean isRole()

Description copied from interface: I_CmsOuTreeType

Checks if the tree type is role-like.

Specified by:

isRole in interface I_CmsOuTreeType

Returns:

true for role-like OUs

See Also:

I_CmsOuTreeType.isRole()

isUser

public boolean isUser()

Description copied from interface: I_CmsOuTreeType

Checks if the tree type is user-like.

Specified by:

isUser in interface I_CmsOuTreeType

Returns:

true for user-like OUs

See Also:

I_CmsOuTreeType.isUser()

isValidForOu

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

Description copied from interface: I_CmsOuTreeType

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

Specified by:

isValidForOu in interface I_CmsOuTreeType

Parameters:

cms - the CMS context

ou - the OU FQN.

Returns:

true if the tree type is valid for the OU

See Also:

I_CmsOuTreeType.isValidForOu(org.opencms.file.CmsObject, java.lang.String)

showInOuTable

public boolean showInOuTable()

Description copied from interface: I_CmsOuTreeType

True if type should be shown in OU overview table.

Specified by:

showInOuTable in interface I_CmsOuTreeType

Returns:

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

See Also:

I_CmsOuTreeType.showInOuTable()