|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.groups.ReferenceComponentGroupService
org.jasig.portal.groups.ReferenceCompositeGroupService
Constructor Summary | |
ReferenceCompositeGroupService()
ReferenceCompositeGroupService constructor comment. |
Method Summary | |
java.util.Iterator |
findContainingGroups(IGroupMember gm)
Returns groups that contain the IGroupMember . |
IEntityGroup |
findGroup(java.lang.String key)
Returns a pre-existing IEntityGroup or null if the
IGroupMember does not exist. |
ILockableEntityGroup |
findGroupWithLock(java.lang.String key,
java.lang.String lockOwner)
Returns a pre-existing IEntityGroup or null if the
IGroupMember 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 svcName)
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 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 class org.jasig.portal.groups.ReferenceComponentGroupService |
getComponentServices, getServiceName, isLeafService, setServiceName |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.jasig.portal.groups.IComponentGroupService |
getComponentServices, getServiceName, isLeafService, setServiceName |
Constructor Detail |
public ReferenceCompositeGroupService() throws GroupsException
Method Detail |
public java.util.Iterator findContainingGroups(IGroupMember gm) throws GroupsException
IGroupMember
. Delegates to the
component services, but only after checking that they might actually contain
a membership for this member.
findContainingGroups
in interface ICompositeGroupService
gm
- IGroupMember
GroupsException
public IEntityGroup findGroup(java.lang.String key) throws GroupsException
IEntityGroup
or null if the
IGroupMember
does not exist.
findGroup
in interface ICompositeGroupService
GroupsException
public ILockableEntityGroup findGroupWithLock(java.lang.String key, java.lang.String lockOwner) throws GroupsException
IEntityGroup
or null if the
IGroupMember
does not exist.
findGroupWithLock
in interface ICompositeGroupService
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.
getEntity
in interface ICompositeGroupService
GroupsException
public IEntity getEntity(java.lang.String key, java.lang.Class type, java.lang.String svcName) throws GroupsException
IEntity
representing a portal entity. This does
not guarantee that the entity actually exists.
getEntity
in interface ICompositeGroupService
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
else it is
an IEntity
.
getGroupMember
in interface ICompositeGroupService
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
.
getGroupMember
in interface ICompositeGroupService
GroupsException
public IEntityGroup newGroup(java.lang.Class type, javax.naming.Name serviceName) throws GroupsException
IEntityGroup
from the named service.
newGroup
in interface ICompositeGroupService
GroupsException
public EntityIdentifier[] searchForEntities(java.lang.String query, int method, java.lang.Class type) throws GroupsException
searchForEntities
in interface ICompositeGroupService
GroupsException
public EntityIdentifier[] searchForEntities(java.lang.String query, int method, java.lang.Class type, IEntityGroup ancestor) throws GroupsException
searchForEntities
in interface ICompositeGroupService
GroupsException
public EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype) throws GroupsException
searchForGroups
in interface ICompositeGroupService
GroupsException
public EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype, IEntityGroup ancestor) throws GroupsException
searchForGroups
in interface ICompositeGroupService
GroupsException
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |