com.saperion.jcs.modules.users.api

Interface Group

All Superinterfaces:

Serializable, TenantSpecificItem, UserManagementItem

All Known Implementing Classes:

DefaultGroup, LazyGroup, WrappedGroup

public interface Group
extends TenantSpecificItem

This interface identifies a group in the saperion user administration.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Group.DefaultGroupFields Fields contained in the default database definition of a group.
static class	Group.GroupFlags
static class	Group.GroupType

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_NOT_SUPPORTED_MESSAGE

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Group group)
Collection<User>	getAllUsers(int depth) Gets all users associated with this group.
Collection<Group>	getContainedGroups() Gets the groups containing this group.
String	getDescription()
String	getDisplayName()
Set<Group.GroupFlags>	getFlags()
Collection<Group>	getGroups()
Group.GroupType	getGroupType()
String	getLanguage()
String	getMailAdress()
Role	getRole()
Collection<User>	getUsers() Gets the users which are directly associated with this group.
void	remove(Group group)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setFlags(Set<Group.GroupFlags> flags)
void	setLanguage(String language)
void	setMailAdress(String mailAdress)
void	setRole(Role role)

Methods inherited from interface com.saperion.jcs.modules.users.api.TenantSpecificItem

getTenant, setTenant

Methods inherited from interface com.saperion.jcs.modules.users.api.UserManagementItem

getExtensions, getId, getMetadata, getName, isFromExtension, setExtensions, setMetadata, setName

Field Detail

OPERATION_NOT_SUPPORTED_MESSAGE

static final String OPERATION_NOT_SUPPORTED_MESSAGE

See Also:

Constant Field Values

Method Detail

getDisplayName

String getDisplayName()

getDescription

String getDescription()

getMailAdress

String getMailAdress()

getRole

Role getRole()

setDisplayName

void setDisplayName(String displayName)

setDescription

void setDescription(String description)

setMailAdress

void setMailAdress(String mailAdress)

setRole

void setRole(Role role)

getFlags

Set<Group.GroupFlags> getFlags()

setFlags

void setFlags(Set<Group.GroupFlags> flags)

getGroupType

Group.GroupType getGroupType()

getGroups

Collection<Group> getGroups()

getContainedGroups

Collection<Group> getContainedGroups()

Gets the groups containing this group.

Returns:

the containing groups of this groups

add

void add(Group group)

remove

void remove(Group group)

getUsers

Collection<User> getUsers()

Gets the users which are directly associated with this group.

Returns:

the users associated directly with this group.

getAllUsers

Collection<User> getAllUsers(int depth)

Gets all users associated with this group.

Walks through the group of group tree upto the given depth and returns all users found in this tree without duplicates.

Parameters:

depth - of group tree search

Returns:

all users of group tree without duplicates

setLanguage

void setLanguage(String language)

getLanguage

String getLanguage()