| org.jasig.portal.groups.IGroupService
| IGroupService | | public interface IGroupService (Code) | | Defines an api for discovering an entry point into the groups system,
represented by an IGroupMember. This is analogous to getting an
InitialContext in JNDI. Subsequent requests for navigating or
maintaining groups go thru the IGroupMember.
author:
Dan Ellentuck
version:
$Revision: 36683 $ICompositeGroupServiceIIndividualGroupService |
| Method Summary | |
| public void | deleteGroup(IEntityGroup group)
Removes the IEntityGroup from the store. | | public Iterator | findContainingGroups(IGroupMember gm)
| | public IEntityGroup | findGroup(String key)
Returns a pre-existing IEntityGroup or null if the
IGroupMember does not exist. | | public Iterator | findMemberGroups(IEntityGroup eg)
| | public IEntity | getEntity(String key, Class type)
Returns an IEntity representing a portal entity. | | public IGroupMember | getGroupMember(String key, Class type)
Returns an IGroupMember representing either a group or a
portal entity. | | public IGroupMember | getGroupMember(EntityIdentifier underlyingEntityIdentifier)
Returns an IGroupMember representing either a group or a
portal entity, based on the EntityIdentifier, which
refers to the UNDERLYING entity for the IGroupMember. | | public IEntityGroupStore | getGroupStore()
Returns an IEntityGroupStore. | | public IEntityGroup | newGroup(Class type)
Returns a new IEntityGroup for the given Class with an unused
key. | | public EntityIdentifier[] | searchForEntities(String query, int method, Class type)
| | public EntityIdentifier[] | searchForEntities(String query, int method, Class type, IEntityGroup ancestor)
| | public EntityIdentifier[] | searchForGroups(String query, int method, Class leaftype)
| | public EntityIdentifier[] | searchForGroups(String query, int method, Class leaftype, IEntityGroup ancestor)
| | public void | updateGroup(IEntityGroup group)
Commits the updated IEntityGroup to the store. | | public void | updateGroupMembers(IEntityGroup group)
Commits the updated IEntityGroup to the store. |
| getGroupMember | | public IGroupMember getGroupMember(String key, Class type) throws GroupsException(Code) | | Returns an IGroupMember representing either a group or a
portal entity. If the parm type is the group type,
the IGroupMember is an IEntityGroup else it is
an IEntity.
|
| getGroupMember | | public IGroupMember getGroupMember(EntityIdentifier underlyingEntityIdentifier) throws GroupsException(Code) | | Returns an IGroupMember representing either a group or a
portal entity, based on the EntityIdentifier, which
refers to the UNDERLYING entity for the IGroupMember.
|
| searchForEntities | | public EntityIdentifier[] searchForEntities(String query, int method, Class type) throws GroupsException(Code) | | Find EntityIdentifiers for entities whose name matches the query string
according to the specified method and is of the specified type
|
| searchForEntities | | public EntityIdentifier[] searchForEntities(String query, int method, Class type, IEntityGroup ancestor) throws GroupsException(Code) | | Find EntityIdentifiers for entities whose name matches the query string
according to the specified method, is of the specified type and
descends from the specified group
|
| searchForGroups | | public EntityIdentifier[] searchForGroups(String query, int method, Class leaftype) throws GroupsException(Code) | | Find EntityIdentifiers for groups whose name matches the query string
according to the specified method and matches the provided leaf type
|
| searchForGroups | | public EntityIdentifier[] searchForGroups(String query, int method, Class leaftype, IEntityGroup ancestor) throws GroupsException(Code) | | Find EntityIdentifiers for groups whose name matches the query string
according to the specified method, has the provided leaf type and
descends from the specified group
|
|
|