com.edorasware.one.identity.group

Class SystemGroups

java.lang.Object

com.edorasware.one.identity.group.SystemGroups

public final class SystemGroups
extends Object

This class describes what group ids make up the system groups. For each tenant, the group ids are different. Within a tenant, the group ids never change. Even though this class operates with ids of type GroupId, they are the ids of type AnyWorkObjectId of the group work objects (work objects of entity type Group.ENTITY_TYPE).

See Also:

SystemRole

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
static SystemGroups	from(com.edorasware.commons.core.entity.GroupId userGroupId, com.edorasware.commons.core.entity.GroupId modelerGroupId, com.edorasware.commons.core.entity.GroupId managerGroupId, com.edorasware.commons.core.entity.GroupId administratorGroupId, com.edorasware.commons.core.entity.GroupId supervisorGroupId, com.edorasware.commons.core.entity.GroupId allUsersGroupId) Creates a new SystemGroups instance from the given system group ids.
com.edorasware.commons.core.entity.GroupId	getAdministratorGroupId() Returns the id of the group that represents the administrators.
com.edorasware.commons.core.entity.GroupId	getAllUsersGroupId() Returns the id of the group that represents all users.
com.edorasware.commons.core.entity.GroupId	getGroupId(SystemRole systemRole) Returns the system group id for the given system role.
com.edorasware.commons.core.entity.GroupId	getManagerGroupId() Returns the id of the group that represents the managers.
com.edorasware.commons.core.entity.GroupId	getModelerGroupId() Returns the id of the group that represents the modelers.
com.google.common.base.Optional<SystemRole>	getRole(com.edorasware.commons.core.entity.GroupId groupId) Maps the given group id to a SystemRole.
com.edorasware.commons.core.entity.GroupId	getSupervisorGroupId() Returns the id of the group that represents the supervisors.
com.edorasware.commons.core.entity.GroupId	getUserGroupId() Returns the id of the group that represents the users.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getUserGroupId

public com.edorasware.commons.core.entity.GroupId getUserGroupId()

Returns the id of the group that represents the users.

Returns:

the id of the user group, never null

getModelerGroupId

public com.edorasware.commons.core.entity.GroupId getModelerGroupId()

Returns the id of the group that represents the modelers.

Returns:

the id of the modeler group, never null

getManagerGroupId

public com.edorasware.commons.core.entity.GroupId getManagerGroupId()

Returns the id of the group that represents the managers.

Returns:

the id of the manager group, never null

getAdministratorGroupId

public com.edorasware.commons.core.entity.GroupId getAdministratorGroupId()

Returns the id of the group that represents the administrators.

Returns:

the id of the administrator group, never null

getSupervisorGroupId

public com.edorasware.commons.core.entity.GroupId getSupervisorGroupId()

Returns the id of the group that represents the supervisors.

Returns:

the id of the supervisor group, never null

getAllUsersGroupId

public com.edorasware.commons.core.entity.GroupId getAllUsersGroupId()

Returns the id of the group that represents all users.

Returns:

the id of the all users group, never null

getGroupId

public com.edorasware.commons.core.entity.GroupId getGroupId(SystemRole systemRole)

Returns the system group id for the given system role.

Parameters:

systemRole - the system role

Returns:

the group id for the given system role, never null

getRole

public com.google.common.base.Optional<SystemRole> getRole(com.edorasware.commons.core.entity.GroupId groupId)

Maps the given group id to a SystemRole.

Parameters:

groupId - the group id to map

Returns:

the corresponding role, if a mapping exists

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

from

public static SystemGroups from(com.edorasware.commons.core.entity.GroupId userGroupId,
                com.edorasware.commons.core.entity.GroupId modelerGroupId,
                com.edorasware.commons.core.entity.GroupId managerGroupId,
                com.edorasware.commons.core.entity.GroupId administratorGroupId,
                com.edorasware.commons.core.entity.GroupId supervisorGroupId,
                com.edorasware.commons.core.entity.GroupId allUsersGroupId)

Creates a new SystemGroups instance from the given system group ids.

Parameters:

userGroupId - the id of the user group

modelerGroupId - the id of the modeler group

managerGroupId - the id of the manager group

administratorGroupId - the id of the administrator group

supervisorGroupId - the id of the supervisor group

allUsersGroupId - the id of the all users group

Returns:

the new instance