org.opencms.file

类 CmsGroup

java.lang.Object

org.opencms.security.CmsPrincipal

org.opencms.file.CmsGroup

所有已实现的接口:

java.lang.Comparable<I_CmsPrincipal>, java.security.Principal, I_CmsPrincipal

public class CmsGroup
extends CmsPrincipal

A group principal in the OpenCms permission system.

从以下版本开始:

6.0.0

另请参阅:

CmsUser

字段概要

从类继承的字段 org.opencms.security.CmsPrincipal

m_description, m_flags, m_id, m_name

从接口继承的字段 org.opencms.security.I_CmsPrincipal

FLAG_CORE_LIMIT, FLAG_DISABLED, FLAG_ENABLED, FLAG_GROUP_PROJECT_MANAGER, FLAG_GROUP_PROJECT_USER, FLAG_GROUP_ROLE, FLAG_GROUP_VIRTUAL, FLAG_USER_MANAGED, FLAG_USER_WEBUSER, PRINCIPAL_GROUP, PRINCIPAL_USER

构造器概要

构造器

构造器和说明
CmsGroup() Creates a new, empty OpenCms group principal.
CmsGroup(CmsUUID id, CmsUUID parentId, java.lang.String name, java.lang.String description, int flags) Creates a new OpenCms group principal.

方法概要

方法

限定符和类型	方法和说明
void	checkName(java.lang.String name) Checks if the provided group name is valid and can be used as an argument value for CmsPrincipal.setName(String).
java.lang.Object	clone()
java.lang.String	getDescription(java.util.Locale locale) Returns the description of this organizational unit.
CmsUUID	getParentId() Returns the parent group id of this group.
boolean	isGroup() Returns true if this principal is of type CmsGroup.
boolean	isProjectCoWorker() Returns true if this group is enabled as a project user group.
boolean	isProjectManager() Returns true if this group is enabled as a project manager group.
boolean	isRole() Checks if this group is a role group.
boolean	isUser() Returns true if this principal is of type CmsUser.
boolean	isVirtual() Checks if this group is a virtual group, emulating a role.
void	setParentId(CmsUUID parentId) Sets the parent group id of this group.
void	setProjectCoWorker(boolean value) Sets the project user flag for this group to the given value.
void	setProjectManager(boolean value) Sets the project manager flag for this group to the given value.
java.lang.String	toString()

从类继承的方法 org.opencms.security.CmsPrincipal

compareTo, equals, filterCoreFlag, filterCoreGroups, filterCoreUsers, filterFlag, getDescription, getDisplayName, getDisplayName, getFlags, getId, getName, getOuFqn, getPrefixedGroup, getPrefixedName, getPrefixedUser, getSimpleName, hashCode, isEnabled, readPrefixedPrincipal, readPrincipal, readPrincipal, readPrincipalIncludingHistory, setDescription, setEnabled, setFlags, setName

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

finalize, getClass, notify, notifyAll, wait, wait, wait

构造器详细资料

CmsGroup

public CmsGroup()

Creates a new, empty OpenCms group principal.

CmsGroup

public CmsGroup(CmsUUID id,
        CmsUUID parentId,
        java.lang.String name,
        java.lang.String description,
        int flags)

Creates a new OpenCms group principal.

参数:

id - the unique id of the group

parentId - the is of the parent group

name - the fully qualified name of the name of the group

description - the description of the group

flags - the flags of the group

方法详细资料

checkName

public void checkName(java.lang.String name)

Checks if the provided group name is valid and can be used as an argument value for CmsPrincipal.setName(String).

A group name must not be empty or whitespace only.

参数:

name - the group name to check

另请参阅:

I_CmsValidationHandler.checkGroupName(String)

clone

public java.lang.Object clone()

覆盖:

clone 在类中 java.lang.Object

另请参阅:

Object.clone()

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

getParentId

public CmsUUID getParentId()

Returns the parent group id of this group.

返回:

the parent group id of this group

isGroup

public boolean isGroup()

从接口复制的说明: I_CmsPrincipal

Returns true if this principal is of type CmsGroup.

指定者:

isGroup 在接口中 I_CmsPrincipal

覆盖:

isGroup 在类中 CmsPrincipal

返回:

true if this principal is of type CmsGroup

另请参阅:

I_CmsPrincipal.isGroup()

isProjectCoWorker

public boolean isProjectCoWorker()

Returns true if this group is enabled as a project user group.

返回:

true if this group is enabled as a project user group

isProjectManager

public boolean isProjectManager()

Returns true if this group is enabled as a project manager group.

返回:

true if this group is enabled as a project manager group

isRole

public boolean isRole()

Checks if this group is a role group.

返回:

true if this group is a role group

isUser

public boolean isUser()

从接口复制的说明: I_CmsPrincipal

Returns true if this principal is of type CmsUser.

指定者:

isUser 在接口中 I_CmsPrincipal

覆盖:

isUser 在类中 CmsPrincipal

返回:

true if this principal is of type CmsUser

另请参阅:

I_CmsPrincipal.isUser()

isVirtual

public boolean isVirtual()

Checks if this group is a virtual group, emulating a role.

返回:

if this group is a virtual group

setParentId

public void setParentId(CmsUUID parentId)

Sets the parent group id of this group.

参数:

parentId - the parent group id to set

setProjectCoWorker

public void setProjectCoWorker(boolean value)

Sets the project user flag for this group to the given value.

参数:

value - the value to set

setProjectManager

public void setProjectManager(boolean value)

Sets the project manager flag for this group to the given value.

参数:

value - the value to set

toString

public java.lang.String toString()

指定者:

toString 在接口中 java.security.Principal

覆盖:

toString 在类中 java.lang.Object

另请参阅:

Object.toString()