| org.jasig.portal.groups.ICompositeGroupService
All known Subclasses: org.jasig.portal.groups.ReferenceCompositeGroupService,
| ICompositeGroupService | | public interface ICompositeGroupService extends IComponentGroupService(Code) | | Defines an api for discovering entry points into a composite groups system
consisting of component group services. These entry points are represented
by IGroupMembers. The role of the IGroupMemberis
somewhat analogous to that of an InitialContext in JNDI. Once
a client gets an IGroupMember, subsequent requests for navigating
the system or maintaining groups go thru the IGroupMember api
and are serviced by the individual component services.
author:
Dan Ellentuck
version:
$Revision: 34758 $ |
| Method Summary | |
| public Iterator | findContainingGroups(IGroupMember gm)
Returns the groups that contain the IGroupMember. | | public IEntityGroup | findGroup(String key)
Returns a pre-existing IEntityGroup or null if it does not
exist. | | public ILockableEntityGroup | findGroupWithLock(String key, String owner)
Returns a pre-existing IEntityGroup or null if it does not
exist. | | public IEntity | getEntity(String key, Class type)
Returns an IEntity representing a portal entity. | | public IEntity | getEntity(String key, Class type, String service)
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 IEntityGroup | newGroup(Class type, Name serviceName)
Returns a new IEntityGroup for the given Class with an unused
key from the named service. | | 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)
|
| 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. Otherwise
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
|
|
|