|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 IGroupMember
is
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.
Method Summary | |
java.util.Iterator |
findContainingGroups(IGroupMember gm)
Returns the groups that contain the IGroupMember . |
IEntityGroup |
findGroup(java.lang.String key)
Returns a pre-existing IEntityGroup or null if it does not
exist. |
ILockableEntityGroup |
findGroupWithLock(java.lang.String key,
java.lang.String owner)
Returns a pre-existing IEntityGroup or null if it does not
exist. |
IEntity |
getEntity(java.lang.String key,
java.lang.Class type)
Returns an IEntity representing a portal entity. |
IEntity |
getEntity(java.lang.String key,
java.lang.Class type,
java.lang.String service)
Returns an IEntity representing a portal entity. |
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 . |
IGroupMember |
getGroupMember(java.lang.String key,
java.lang.Class type)
Returns an IGroupMember representing either a group or a
portal entity. |
IEntityGroup |
newGroup(java.lang.Class type,
javax.naming.Name serviceName)
Returns a new IEntityGroup for the given Class with an unused
key from the named service. |
EntityIdentifier[] |
searchForEntities(java.lang.String query,
int method,
java.lang.Class type)
Find EntityIdentifiers for entities whose name matches the query string according to the specified method and is of the specified type |
EntityIdentifier[] |
searchForEntities(java.lang.String query,
int method,
java.lang.Class type,
IEntityGroup ancestor)
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 |
EntityIdentifier[] |
searchForGroups(java.lang.String query,
int method,
java.lang.Class leaftype)
Find EntityIdentifiers for groups whose name matches the query string according to the specified method and matches the provided leaf type |
EntityIdentifier[] |
searchForGroups(java.lang.String query,
int method,
java.lang.Class leaftype,
IEntityGroup ancestor)
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 |
Methods inherited from interface org.jasig.portal.groups.IComponentGroupService |
getComponentServices, getServiceName, isLeafService, setServiceName |
Method Detail |
public java.util.Iterator findContainingGroups(IGroupMember gm) throws GroupsException
IGroupMember
.
gm
- IGroupMember
GroupsException
public IEntityGroup findGroup(java.lang.String key) throws GroupsException
IEntityGroup
or null if it does not
exist.
GroupsException
public ILockableEntityGroup findGroupWithLock(java.lang.String key, java.lang.String owner) throws GroupsException
IEntityGroup
or null if it does not
exist.
GroupsException
public IEntity getEntity(java.lang.String key, java.lang.Class type) throws GroupsException
IEntity
representing a portal entity. This does
not guarantee that the entity actually exists.
GroupsException
public IEntity getEntity(java.lang.String key, java.lang.Class type, java.lang.String service) throws GroupsException
IEntity
representing a portal entity. This does
not guarantee that the entity actually exists.
GroupsException
public IGroupMember getGroupMember(java.lang.String key, java.lang.Class type) throws GroupsException
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
.
GroupsException
public IGroupMember getGroupMember(EntityIdentifier underlyingEntityIdentifier) throws GroupsException
IGroupMember
representing either a group or a
portal entity, based on the EntityIdentifier
, which refers
to the UNDERLYING entity for the IGroupMember
.
GroupsException
public IEntityGroup newGroup(java.lang.Class type, javax.naming.Name serviceName) throws GroupsException
IEntityGroup
for the given Class with an unused
key from the named service.
GroupsException
public EntityIdentifier[] searchForEntities(java.lang.String query, int method, java.lang.Class type) throws GroupsException
GroupsException
public EntityIdentifier[] searchForEntities(java.lang.String query, int method, java.lang.Class type, IEntityGroup ancestor) throws GroupsException
GroupsException
public EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype) throws GroupsException
GroupsException
public EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype, IEntityGroup ancestor) throws GroupsException
GroupsException
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |