org.jasig.portal.groups
Interface IEntityGroupStore

All Superinterfaces:

IGroupConstants

All Known Implementing Classes:

FileSystemGroupStore, LDAPGroupStore, PersonAttributesGroupStore, RDBMEntityGroupStore, SmartLdapGroupStore

public interface IEntityGroupStore
extends IGroupConstants

Interface for finding and maintaining IEntityGroups.

Version:

1.0, 11/29/01

Author:

Dan Ellentuck

Field Summary

Fields inherited from interface org.jasig.portal.groups.IGroupConstants

CHANNEL_CATEGORIES, CONTAINS, ENDS_WITH, EVERYONE, IS, NODE_SEPARATOR, PORTAL_ADMINISTRATORS, STARTS_WITH

Method Summary

boolean	contains(IEntityGroup group, IGroupMember member) Answers if group contains member.
void	delete(IEntityGroup group) Delete this IEntityGroup from the data store.
IEntityGroup	find(String key) Returns an instance of the IEntityGroup from the data store.
Iterator	findContainingGroups(IGroupMember gm) Returns an Iterator over the Collection of IEntityGroups that the IGroupMember belongs to.
Iterator	findEntitiesForGroup(IEntityGroup group) Returns an Iterator over the Collection of IEntities that are members of this IEntityGroup.
ILockableEntityGroup	findLockable(String key) Returns an instance of the ILockableEntityGroup from the data store.
String[]	findMemberGroupKeys(IEntityGroup group) Returns a String[] containing the keys of IEntityGroups that are members of this IEntityGroup.
Iterator	findMemberGroups(IEntityGroup group) Returns an Iterator over the Collection of IEntityGroups that are members of this IEntityGroup.
IEntityGroup	newInstance(Class entityType)
EntityIdentifier[]	searchForGroups(String query, int method, Class leaftype) Find EntityIdentifiers for groups whose name matches the query string according to the specified method and matches the provided leaf type
void	update(IEntityGroup group) Adds or updates the IEntityGroup AND ITS MEMBERSHIPS to the data store, as appropriate.
void	updateMembers(IEntityGroup group) Commits the group memberships of the IEntityGroup to the data store.

Method Detail

contains

boolean contains(IEntityGroup group,
                 IGroupMember member)
                 throws GroupsException

Answers if group contains member.

Parameters:

group - org.jasig.portal.groups.IEntityGroup

member - org.jasig.portal.groups.IGroupMember

Returns:

boolean

Throws:

GroupsException

delete

void delete(IEntityGroup group)
            throws GroupsException

Delete this IEntityGroup from the data store.

Parameters:

group - org.jasig.portal.groups.IEntityGroup

Throws:

GroupsException

find

IEntityGroup find(String key)
                  throws GroupsException

Returns an instance of the IEntityGroup from the data store.

Parameters:

key - java.lang.String

Returns:

org.jasig.portal.groups.IEntityGroup

Throws:

GroupsException

findContainingGroups

Iterator findContainingGroups(IGroupMember gm)
                              throws GroupsException

Returns an Iterator over the Collection of IEntityGroups that the IGroupMember belongs to.

Parameters:

gm - org.jasig.portal.groups.IEntityGroup

Returns:

java.util.Iterator

Throws:

GroupsException

findEntitiesForGroup

Iterator findEntitiesForGroup(IEntityGroup group)
                              throws GroupsException

Returns an Iterator over the Collection of IEntities that are members of this IEntityGroup.

Parameters:

group - org.jasig.portal.groups.IEntityGroup

Returns:

java.util.Iterator

Throws:

GroupsException

findLockable

ILockableEntityGroup findLockable(String key)
                                  throws GroupsException

Returns an instance of the ILockableEntityGroup from the data store.

Parameters:

key - java.lang.String

Returns:

org.jasig.portal.groups.IEntityGroup

Throws:

GroupsException

findMemberGroupKeys

String[] findMemberGroupKeys(IEntityGroup group)
                             throws GroupsException

Returns a String[] containing the keys of IEntityGroups that are members of this IEntityGroup. In a composite group system, a group may contain a member group from a different service. This is called a foreign membership, and is only possible in an internally-managed service. A group store in such a service can return the key of a foreign member group, but not the group itself, which can only be returned by its local store.

Parameters:

group - org.jasig.portal.groups.IEntityGroup

Returns:

String[]

Throws:

GroupsException

findMemberGroups

Iterator findMemberGroups(IEntityGroup group)
                          throws GroupsException

Returns an Iterator over the Collection of IEntityGroups that are members of this IEntityGroup.

Parameters:

group - org.jasig.portal.groups.IEntityGroup

Returns:

java.util.Iterator

Throws:

GroupsException

newInstance

IEntityGroup newInstance(Class entityType)
                         throws GroupsException

Returns:

org.jasig.portal.groups.IEntityGroup

Throws:

GroupsException

searchForGroups

EntityIdentifier[] searchForGroups(String query,
                                   int method,
                                   Class leaftype)
                                   throws GroupsException

Find EntityIdentifiers for groups whose name matches the query string according to the specified method and matches the provided leaf type

Throws:

GroupsException

update

void update(IEntityGroup group)
            throws GroupsException

Adds or updates the IEntityGroup AND ITS MEMBERSHIPS to the data store, as appropriate.

Parameters:

group - org.jasig.portal.groups.IEntityGroup

Throws:

GroupsException

updateMembers

void updateMembers(IEntityGroup group)
                   throws GroupsException

Commits the group memberships of the IEntityGroup to the data store.

Parameters:

group - org.jasig.portal.groups.IEntityGroup

Throws:

GroupsException