CmsOrganizationalUnit

java.lang.Object
- org.opencms.security.CmsOrganizationalUnit

```
public class CmsOrganizationalUnit
extends java.lang.Object
```
An organizational unit in OpenCms.
Be sure the flags does not conflict with the flags defined in CmsResource.

从以下版本开始:

6.5.6

字段概要

字段
限定符和类型	字段和说明
`static int`	`FLAG_HIDE_LOGIN` The flag constant to hide the organizational units from the login form.
`static int`	`FLAG_WEBUSERS` The flag constant to mark the organizational units as containing only webusers.
`static java.lang.String`	`SEPARATOR` The character used to separate each level in a fully qualified name.

构造器概要

构造器
构造器和说明
`CmsOrganizationalUnit(CmsUUID id, java.lang.String fqn, java.lang.String description, int flags, CmsUUID projectId)` Creates a new OpenCms organizational unit principal.

方法概要

方法
限定符和类型	方法和说明
`void`	`addFlag(int flag)` Adds the given flag to the flags for this organizational unit.
`java.lang.Object`	`clone()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDescription()` Returns the description of this organizational unit.
`java.lang.String`	`getDescription(java.util.Locale locale)` Returns the description of this organizational unit.
`java.lang.String`	`getDisplayName(java.util.Locale locale)` Returns the display name for this organizational unit.
`int`	`getFlags()` Returns the flags of this organizational unit.
`CmsUUID`	`getId()` Returns the id of this organizational unit.
`java.lang.String`	`getName()` Returns the fully qualified name of this organizational unit.
`java.lang.String`	`getParentFqn()` Returns the full qualified name of the parent organizational unit of this organizational unit.
`static java.lang.String`	`getParentFqn(java.lang.String fqn)` Returns the parent fully qualified name.
`CmsUUID`	`getProjectId()` Returns the id of the related default project.
`java.lang.String`	`getSimpleName()` Returns the simple name of this organizational unit.
`static java.lang.String`	`getSimpleName(java.lang.String fqn)` Returns the last name of the given fully qualified name.
`boolean`	`hasFlag(int flag)` Checks if this organizational unit has the given flag set.
`boolean`	`hasFlagHideLogin()` Checks if this organizational unit has the "hide from login form" flag set.
`boolean`	`hasFlagWebuser()` Checks if this organizational unit has the "webusers" flag set.
`int`	`hashCode()`
`static java.lang.String`	`prefixWithOu(java.lang.String ou, java.lang.String principal)` Prefixes a simple name with an OU.
`static java.lang.String`	`removeLeadingSeparator(java.lang.String fqn)` Returns the given fully qualified name without leading separator.
`void`	`setDescription(java.lang.String description)` Sets the description of this organizational unit.
`void`	`setFlagHideLogin()` Sets the "hide from login form" flag.
`void`	`setFlags(int value)` Sets this organizational unit flags to the specified value.
`void`	`setFlagWebusers()` Sets the "webusers" flag.
`java.lang.String`	`toString()`

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - FLAG_HIDE_LOGIN
```
public static final int FLAG_HIDE_LOGIN
```
    The flag constant to hide the organizational units from the login form.
    
    另请参阅:
    常量字段值
  - FLAG_WEBUSERS
```
public static final int FLAG_WEBUSERS
```
    The flag constant to mark the organizational units as containing only webusers.
    
    另请参阅:
    常量字段值
  - SEPARATOR
```
public static final java.lang.String SEPARATOR
```
    The character used to separate each level in a fully qualified name.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsOrganizationalUnit
```
public CmsOrganizationalUnit(CmsUUID id,
                     java.lang.String fqn,
                     java.lang.String description,
                     int flags,
                     CmsUUID projectId)
```
    Creates a new OpenCms organizational unit principal.
    
    参数:
    id - the unique id of the organizational unit
    fqn - the fully qualified name of the this organizational unit (should end with slash)
    description - the description of the organizational unit
    flags - the flags of the organizational unit
    projectId - the id of the related default project
- 方法详细资料
  - getParentFqn
```
public static final java.lang.String getParentFqn(java.lang.String fqn)
```
    Returns the parent fully qualified name.
    This is null for the root ou, and the empty string for first level ous.
    
    参数:
    fqn - the fully qualified name to get the parent from
    
    返回:
    the parent fully qualified name
  - getSimpleName
```
public static final java.lang.String getSimpleName(java.lang.String fqn)
```
    Returns the last name of the given fully qualified name.
    
    参数:
    fqn - the fully qualified name to get the last name from
    
    返回:
    the last name of the given fully qualified name
  - prefixWithOu
```
public static java.lang.String prefixWithOu(java.lang.String ou,
                            java.lang.String principal)
```
    Prefixes a simple name with an OU.
    
    参数:
    ou - the OU to use as a prefix
    principal - the simple name to which the OU should be prepended
    
    返回:
    the FQN
  - removeLeadingSeparator
```
public static java.lang.String removeLeadingSeparator(java.lang.String fqn)
```
    Returns the given fully qualified name without leading separator.
    
    参数:
    fqn - the fully qualified name to fix
    
    返回:
    the given fully qualified name without leading separator
  - addFlag
```
public void addFlag(int flag)
```
    Adds the given flag to the flags for this organizational unit.
    
    参数:
    flag - the flag to add
  - clone
```
public java.lang.Object clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object
    
    另请参阅:
    Object.clone()
  - equals
```
public boolean equals(java.lang.Object obj)
```
    覆盖:
    
    equals 在类中 java.lang.Object
    
    另请参阅:
    Object.equals(java.lang.Object)
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description of this organizational unit.
    This could return also just a macro, so please use the getDescription(Locale) method.
    
    返回:
    the description of this organizational unit
  - getDescription
```
public java.lang.String getDescription(java.util.Locale locale)
```
    Returns the description of this organizational unit.
    
    参数:
    locale - the locale
    
    返回:
    the description of this organizational unit
  - getDisplayName
```
public java.lang.String getDisplayName(java.util.Locale locale)
```
    Returns the display name for this organizational unit.
    
    参数:
    locale - the locale
    
    返回:
    the display name for this organizational unit
  - getFlags
```
public int getFlags()
```
    Returns the flags of this organizational unit.
    The organizational unit flags are used to store special information about the organizational unit state encoded bitwise. Usually the flags int value should not be directly accessed.
    
    返回:
    the flags of this organizational unit
  - getId
```
public CmsUUID getId()
```
    Returns the id of this organizational unit.
    
    返回:
    the id of this organizational unit.
  - getName
```
public java.lang.String getName()
```
    Returns the fully qualified name of this organizational unit.
    
    返回:
    the fully qualified name of this organizational unit
  - getParentFqn
```
public java.lang.String getParentFqn()
```
    Returns the full qualified name of the parent organizational unit of this organizational unit.
    This is null for the root ou, and the empty string for first level ous.
    
    返回:
    the full qualified name of the parent organizational unit of this organizational unit
  - getProjectId
```
public CmsUUID getProjectId()
```
    Returns the id of the related default project.
    
    返回:
    the id of the related default project
  - getSimpleName
```
public java.lang.String getSimpleName()
```
    Returns the simple name of this organizational unit.
    
    返回:
    the simple name of this organizational unit.
  - hasFlag
```
public boolean hasFlag(int flag)
```
    Checks if this organizational unit has the given flag set.
    
    参数:
    flag - the flag to check
    
    返回:
    true if this organizational unit has the given flag set
  - hasFlagHideLogin
```
public boolean hasFlagHideLogin()
```
    Checks if this organizational unit has the "hide from login form" flag set.
    
    返回:
    true if this organizational unit has the "hide from login form" flag set
  - hasFlagWebuser
```
public boolean hasFlagWebuser()
```
    Checks if this organizational unit has the "webusers" flag set.
    
    返回:
    true if this organizational unit has the "webusers" flag set
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    另请参阅:
    Object.hashCode()
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the description of this organizational unit.
    
    参数:
    description - the principal organizational unit to set
  - setFlagHideLogin
```
public void setFlagHideLogin()
```
    Sets the "hide from login form" flag.
  - setFlags
```
public void setFlags(int value)
```
    Sets this organizational unit flags to the specified value.
    The organizational unit flags are used to store special information about the organizational units state encoded bitwise. Usually the flags int value should not be directly accessed.
    
    参数:
    value - the value to set this organizational units flags to
  - setFlagWebusers
```
public void setFlagWebusers()
```
    Sets the "webusers" flag.
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
    
    另请参阅:
    Object.toString()

类 CmsOrganizationalUnit

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

FLAG_HIDE_LOGIN

FLAG_WEBUSERS

SEPARATOR

构造器详细资料

CmsOrganizationalUnit

方法详细资料

getParentFqn

getSimpleName

prefixWithOu

removeLeadingSeparator

addFlag

clone

equals

getDescription

getDescription

getDisplayName

getFlags

getId

getName

getParentFqn

getProjectId

getSimpleName

hasFlag

hasFlagHideLogin

hasFlagWebuser

hashCode

setDescription

setFlagHideLogin

setFlags

setFlagWebusers

toString