eu.ehri.project.models

Interface Group

All Superinterfaces:

Accessible, Accessor, Entity, Identifiable, ItemHolder, Named, PermissionGrantTarget, PermissionScope, com.tinkerpop.frames.VertexFrame

All Known Implementing Classes:

Group.Impl

public interface Group
extends Accessor, Accessible, PermissionScope, Named, ItemHolder

Frame class representing a group of users or other groups that can be assigned permissions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Group.Impl Implementation of complex methods.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_GROUP_IDENTIFIER
static String	ADMIN_GROUP_NAME
static String	ANONYMOUS_GROUP_IDENTIFIER

Fields inherited from interface eu.ehri.project.models.base.ItemHolder

CHILD_COUNT

Method Summary

Modifier and Type	Method and Description
void	addMember(Accessor accessor) Adds a Accessor as a member to this Group, so it has the permissions of the Group.
Iterable<Accessible>	getAllUserProfileMembers() Get all members of this group, including members of groups within this group.
int	getChildCount() Get the number of items within this group.
Iterable<Group>	getGroups() Fetch the groups to which this group belongs.
Iterable<Accessor>	getMembers() Get members of this group.
Iterable<Accessible>	getMembersAsEntities() TODO FIXME use this in case we need AccesibleEnity's instead of Accessors,
void	removeMember(Accessor accessor) Removes a member from this group.

Methods inherited from interface eu.ehri.project.models.base.Accessor

addPermissionGrant, getAllParents, getParents, getPermissionGrants, isAdmin, isAnonymous

Methods inherited from interface eu.ehri.project.models.base.Accessible

addAccessor, getAccessors, getHistory, getLatestEvent, getPermissionScope, getPermissionScopes, hasAccessRestriction, removeAccessor, setPermissionScope

Methods inherited from interface eu.ehri.project.models.base.PermissionGrantTarget

getPermissionGrants

Methods inherited from interface eu.ehri.project.models.base.PermissionScope

getAllContainedItems, getContainedItems, getPermissionGrants, getPermissionScopes, idPath

Methods inherited from interface eu.ehri.project.models.base.Identifiable

getIdentifier

Methods inherited from interface eu.ehri.project.models.base.Entity

as, getId, getProperty, getProperty, getPropertyKeys, getType

Methods inherited from interface com.tinkerpop.frames.VertexFrame

asVertex

Methods inherited from interface eu.ehri.project.models.base.Named

getName

Field Detail

ADMIN_GROUP_IDENTIFIER

static final String ADMIN_GROUP_IDENTIFIER

See Also:

Constant Field Values

ANONYMOUS_GROUP_IDENTIFIER

static final String ANONYMOUS_GROUP_IDENTIFIER

See Also:

Constant Field Values

ADMIN_GROUP_NAME

static final String ADMIN_GROUP_NAME

See Also:

Constant Field Values

Method Detail

getGroups

Iterable<Group> getGroups()

Fetch the groups to which this group belongs.

Returns:

an iterable of group frames

getMembersAsEntities

Iterable<Accessible> getMembersAsEntities()

TODO FIXME use this in case we need AccesibleEnity's instead of Accessors,

getMembers

Iterable<Accessor> getMembers()

Get members of this group.

Returns:

an iterable of user or group frames

getChildCount

int getChildCount()

Get the number of items within this group.

Specified by:

getChildCount in interface ItemHolder

Returns:

a count of group members

addMember

void addMember(Accessor accessor)

Adds a Accessor as a member to this Group, so it has the permissions of the Group.

Parameters:

accessor - a user or group frame

removeMember

void removeMember(Accessor accessor)

Removes a member from this group.

Parameters:

accessor - a user or group frame

getAllUserProfileMembers

Iterable<Accessible> getAllUserProfileMembers()

Get all members of this group, including members of groups within this group.

Returns:

an iterable of user or group frames