org.opencms.file
Class CmsGroup

java.lang.Object
  org.opencms.security.CmsPrincipal
      org.opencms.file.CmsGroup

All Implemented Interfaces:

Principal, I_CmsPrincipal

public class CmsGroup
extends CmsPrincipal
implements I_CmsPrincipal

A group principal in the OpenCms permission system.

Since:

6.0.0

Version:

$Revision: 1.19 $

Author:

Alexander Kandzior, Michael Emmerich

See Also:

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, String name, String description, int flags)
Creates a new OpenCms group principal.

Method Summary

static void	checkGroupName(String name) Checks if the provided group name is a valid group name, that is contains only valid characters.
void	checkName(String name) Checks if the provided group name is valid and can be used as an argument value for CmsPrincipal.setName(String).
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 CmsGroup.
boolean	isUser() Returns true if this principal is of type CmsUser.
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.
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

CmsGroup

public CmsGroup()

Creates a new, empty OpenCms group principal.

CmsGroup

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

Creates a new OpenCms group principal.

Parameters:

id - the unique id of the group

parentId - the is of the parent group

name - the name of the group

description - the description of the group

flags - the flags of the group

Method Detail

checkGroupName

public static void checkGroupName(String name)
                           throws CmsIllegalArgumentException

Checks if the provided group name is a valid group name, that is contains only valid characters.

A group name must not be empty or whitespace only.

Parameters:

name - the group name to check

Throws:

CmsIllegalArgumentException - if the given group name is not valid

checkName

public void checkName(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.

Specified by:

checkName in interface I_CmsPrincipal

Parameters:

name - the group name to check

See Also:

checkGroupName(String)

clone

public Object clone()

Overrides:

clone in class Object

See Also:

Object.clone()

getDisabled

public boolean getDisabled()

Deprecated. use CmsPrincipal.isEnabled() instead

Returns true if this group is disabled.

Returns:

true if this group is disabled

getParentId

public CmsUUID getParentId()

Returns the parent group id of this group.

Returns:

the parent group id of this group

getProjectCoWorker

public boolean getProjectCoWorker()

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

Returns:

true if this group is enabled as a project user group

getProjectManager

public boolean getProjectManager()

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

Returns:

true if this group is enabled as a project manager group

getRole

public boolean getRole()

Returns true if this group is enabled as a role for tasks.

Returns:

true if this group is enabled as a role for tasks

isGroup

public boolean isGroup()

Description copied from interface: I_CmsPrincipal

Returns true if this principal is of type CmsGroup.

Specified by:

isGroup in interface I_CmsPrincipal

Overrides:

isGroup in class CmsPrincipal

Returns:

true if this principal is of type CmsGroup

See Also:

I_CmsPrincipal.isGroup()

isUser

public boolean isUser()

Description copied from interface: I_CmsPrincipal

Returns true if this principal is of type CmsUser.

Specified by:

isUser in interface I_CmsPrincipal

Overrides:

isUser in class CmsPrincipal

Returns:

true if this principal is of type CmsUser

See Also:

I_CmsPrincipal.isUser()

setDisabled

public void setDisabled()

Deprecated. use CmsPrincipal.setEnabled(boolean) instead

Disables this group.

setEnabled

public void setEnabled()

Deprecated. use CmsPrincipal.setEnabled(boolean) instead

Enables this group.

setParentId

public void setParentId(CmsUUID parentId)

Sets the parent group id of this group.

Parameters:

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.

Parameters:

value - the value to set

setProjectManager

public void setProjectManager(boolean value)

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

Parameters:

value - the value to set

setRole

public void setRole(boolean value)

Sets the "role for tasks" flag for this group to the given value.

Parameters:

value - the value to set

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object

See Also:

Object.toString()