|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.security.CmsPrincipal
org.opencms.file.CmsGroup
A group principal in the OpenCms permission system.
CmsUser
Field Summary |
Fields inherited from class org.opencms.security.CmsPrincipal |
m_description, m_flags, m_id, m_name |
Fields inherited from interface org.opencms.security.I_CmsPrincipal |
FLAG_CORE_LIMIT, FLAG_DISABLED, FLAG_ENABLED, FLAG_GROUP_PROJECT_MANAGER, FLAG_GROUP_PROJECT_USER, FLAG_GROUP_WORKFLOW_ROLE, PRINCIPAL_GROUP, PRINCIPAL_USER |
Constructor Summary | |
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. |
Method Summary | |
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()
|
boolean |
getDisabled()
Deprecated. use CmsPrincipal.isEnabled() instead |
CmsUUID |
getParentId()
Returns the parent group id of this group. |
boolean |
getProjectCoWorker()
Returns true if this group is enabled as a project user group. |
boolean |
getProjectManager()
Returns true if this group is enabled as a project manager group. |
boolean |
getRole()
Returns true if this group is enabled as a role for tasks. |
boolean |
isGroup()
Returns true if this principal is of type . |
boolean |
isUser()
Returns true if this principal is of type . |
void |
setDisabled()
Deprecated. use CmsPrincipal.setEnabled(boolean) instead |
void |
setEnabled()
Deprecated. use CmsPrincipal.setEnabled(boolean) instead |
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. |
void |
setRole(boolean value)
Sets the "role for tasks" flag for this group to the given value. |
java.lang.String |
toString()
|
Methods inherited from class org.opencms.security.CmsPrincipal |
equals, filterCore, filterCoreFlag, filterFlag, getDescription, getFlags, getId, getName, getPrefixedGroup, getPrefixedName, getPrefixedUser, hashCode, isEnabled, readPrefixedPrincipal, readPrincipal, setDescription, setEnabled, setFlags, setName |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.opencms.security.I_CmsPrincipal |
equals, getDescription, getFlags, getId, getName, getPrefixedName, hashCode, isEnabled, setDescription, setEnabled, setFlags, setName |
Constructor Detail |
public CmsGroup()
public CmsGroup(CmsUUID id, CmsUUID parentId, java.lang.String name, java.lang.String description, int flags)
id
- the unique id of the groupparentId
- the is of the parent groupname
- the name of the groupdescription
- the description of the groupflags
- the flags of the groupMethod Detail |
public void checkName(java.lang.String name)
CmsPrincipal.setName(String)
.A group name must not be empty or whitespace only.
checkName
in interface I_CmsPrincipal
name
- the group name to checkI_CmsValidationHandler.checkGroupName(String)
public java.lang.Object clone()
Object.clone()
public boolean getDisabled()
CmsPrincipal.isEnabled()
instead
public CmsUUID getParentId()
public boolean getProjectCoWorker()
true
if this group is enabled as a project user group.
true
if this group is enabled as a project user grouppublic boolean getProjectManager()
true
if this group is enabled as a project manager group.
true
if this group is enabled as a project manager grouppublic boolean getRole()
true
if this group is enabled as a role for tasks.
true
if this group is enabled as a role for taskspublic boolean isGroup()
I_CmsPrincipal
true
if this principal is of type CmsGroup
.
isGroup
in interface I_CmsPrincipal
isGroup
in class CmsPrincipal
I_CmsPrincipal.isGroup()
public boolean isUser()
I_CmsPrincipal
true
if this principal is of type CmsUser
.
isUser
in interface I_CmsPrincipal
isUser
in class CmsPrincipal
I_CmsPrincipal.isUser()
public void setDisabled()
CmsPrincipal.setEnabled(boolean)
instead
public void setEnabled()
CmsPrincipal.setEnabled(boolean)
instead
public void setParentId(CmsUUID parentId)
parentId
- the parent group id to setpublic void setProjectCoWorker(boolean value)
value
- the value to setpublic void setProjectManager(boolean value)
value
- the value to setpublic void setRole(boolean value)
value
- the value to setpublic java.lang.String toString()
toString
in interface java.security.Principal
Object.toString()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |