|
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
org.jasig.portal.groups.ReferenceIndividualGroupService
Reference individual, or leaf, group service.
Constructor Summary | |
ReferenceIndividualGroupService()
ReferenceGroupsService constructor. |
|
ReferenceIndividualGroupService(ComponentGroupServiceDescriptor svcDescriptor)
ReferenceGroupsService constructor. |
Method Summary | |
boolean |
contains(IEntityGroup group,
IGroupMember member)
Answers if group contains member . |
void |
deleteGroup(IEntityGroup group)
Removes the IEntityGroup from the cache and the store. |
void |
deleteGroup(ILockableEntityGroup group)
Removes the ILockableEntityGroup from the cache and the store,
including both parent and child memberships. |
java.util.Iterator |
findContainingGroups(IGroupMember gm)
Returns and caches the containing groups for the IGroupMember |
IEntityGroup |
findGroup(CompositeEntityIdentifier ent)
Returns a pre-existing IEntityGroup or null if it
does not exist. |
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 ILockableEntityGroup or null if the
group is not found. |
ILockableEntityGroup |
findGroupWithLock(java.lang.String key,
java.lang.String owner,
int secs)
Returns a pre-existing ILockableEntityGroup or null if the
group is not found. |
java.util.Iterator |
findMemberEntities(IEntityGroup group)
Finds the IEntities that are members of group . |
java.util.Iterator |
findMemberGroups(IEntityGroup eg)
Returns member groups for the IEntityGroup . |
java.util.Iterator |
findMembers(IEntityGroup eg)
Returns and members for the IEntityGroup . |
IEntity |
getEntity(java.lang.String key,
java.lang.Class type)
Returns an IEntity representing a portal entity. |
IEntityStore |
getEntityFactory()
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. |
IEntityGroupStore |
getGroupStore()
Returns the implementation of IEntityGroupStore whose class name
was retrieved by the PropertiesManager (see initialize()). |
boolean |
isEditable()
Answers if this service is updateable by the portal. |
boolean |
isEditable(IEntityGroup group)
Answers if the group can be updated or deleted in the store. |
boolean |
isLeafService()
Answers if this service is a leaf in the composite; a service that actually operates on groups. |
IEntityGroup |
newGroup(java.lang.Class type)
Returns a new IEntityGroup for the given Class with an unused
key. |
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 |
void |
updateGroup(IEntityGroup group)
Update the store and the updated members. |
void |
updateGroup(ILockableEntityGroup group)
Updates the ILockableEntityGroup in the cache and the store. |
void |
updateGroup(ILockableEntityGroup group,
boolean renewLock)
Updates the ILockableEntityGroup in the store and removes
it from the cache. |
void |
updateGroupMembers(IEntityGroup group)
Update the store and the updated members. |
void |
updateGroupMembers(ILockableEntityGroup group)
Updates the ILockableEntityGroup in the cache and the store. |
void |
updateGroupMembers(ILockableEntityGroup group,
boolean renewLock)
Updates the ILockableEntityGroup in the store and removes
it from the cache. |
Methods inherited from class org.jasig.portal.groups.ReferenceCompositeGroupService |
getEntity, newGroup |
Methods inherited from class org.jasig.portal.groups.ReferenceComponentGroupService |
getComponentServices, getServiceName, 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.ICompositeGroupService |
getEntity, newGroup |
Methods inherited from interface org.jasig.portal.groups.IComponentGroupService |
getComponentServices, getServiceName, setServiceName |
Constructor Detail |
public ReferenceIndividualGroupService() throws GroupsException
public ReferenceIndividualGroupService(ComponentGroupServiceDescriptor svcDescriptor) throws GroupsException
Method Detail |
public void deleteGroup(IEntityGroup group) throws GroupsException
IEntityGroup
from the cache and the store.
deleteGroup
in interface IIndividualGroupService
group
- IEntityGroup
GroupsException
public void deleteGroup(ILockableEntityGroup group) throws GroupsException
ILockableEntityGroup
from the cache and the store,
including both parent and child memberships.
deleteGroup
in interface ILockableGroupService
group
- ILockableEntityGroup
GroupsException
public java.util.Iterator findContainingGroups(IGroupMember gm) throws GroupsException
IGroupMember
findContainingGroups
in interface ICompositeGroupService
findContainingGroups
in class ReferenceCompositeGroupService
gm
- IGroupMember
GroupsException
public IEntityGroup findGroup(java.lang.String key) throws GroupsException
IEntityGroup
or null if it
does not exist.
findGroup
in interface ICompositeGroupService
findGroup
in class ReferenceCompositeGroupService
GroupsException
public IEntityGroup findGroup(CompositeEntityIdentifier ent) throws GroupsException
IEntityGroup
or null if it
does not exist.
findGroup
in interface IIndividualGroupService
ent
- CompositeEntityIdentifier
GroupsException
public ILockableEntityGroup findGroupWithLock(java.lang.String key, java.lang.String owner) throws GroupsException
ILockableEntityGroup
or null if the
group is not found.
findGroupWithLock
in interface ICompositeGroupService
findGroupWithLock
in class ReferenceCompositeGroupService
GroupsException
public ILockableEntityGroup findGroupWithLock(java.lang.String key, java.lang.String owner, int secs) throws GroupsException
ILockableEntityGroup
or null if the
group is not found.
findGroupWithLock
in interface ILockableGroupService
key
- String - the group key.owner
- String - the lock owner.secs
- int - the duration of the lock in seconds.
GroupsException
public java.util.Iterator findMemberEntities(IEntityGroup group) throws GroupsException
IEntities
that are members of group
.
GroupsException
public java.util.Iterator findMemberGroups(IEntityGroup eg) throws GroupsException
IEntityGroup
. First get the
member groups that are local to this service. Then retrieve the keys of
all of the member groups and ask the GroupService to find the groups
we do not yet have.
findMemberGroups
in interface IGroupService
eg
- IEntityGroup
GroupsException
public java.util.Iterator findMembers(IEntityGroup eg) throws GroupsException
IEntityGroup
.
findMembers
in interface IIndividualGroupService
eg
- IEntityGroup
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 underlying entity actually exists.
getEntity
in interface ICompositeGroupService
getEntity
in class ReferenceCompositeGroupService
GroupsException
public IEntityStore getEntityFactory()
IEntity
representing a portal entity. This does
not guarantee that the entity actually exists.
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
getGroupMember
in class ReferenceCompositeGroupService
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
getGroupMember
in class ReferenceCompositeGroupService
GroupsException
public IEntityGroupStore getGroupStore() throws GroupsException
IEntityGroupStore
whose class name
was retrieved by the PropertiesManager (see initialize()).
getGroupStore
in interface IGroupService
GroupsException
public boolean isEditable(IEntityGroup group) throws GroupsException
isEditable
in interface IIndividualGroupService
group
- IEntityGroup
GroupsException
public boolean isLeafService()
isLeafService
in interface IComponentGroupService
isLeafService
in class ReferenceComponentGroupService
public boolean isEditable()
isEditable
in interface IIndividualGroupService
public IEntityGroup newGroup(java.lang.Class type) throws GroupsException
IEntityGroup
for the given Class with an unused
key.
newGroup
in interface IIndividualGroupService
GroupsException
public EntityIdentifier[] searchForEntities(java.lang.String query, int method, java.lang.Class type) throws GroupsException
ICompositeGroupService
searchForEntities
in interface ICompositeGroupService
searchForEntities
in class ReferenceCompositeGroupService
GroupsException
public EntityIdentifier[] searchForEntities(java.lang.String query, int method, java.lang.Class type, IEntityGroup ancestor) throws GroupsException
ICompositeGroupService
searchForEntities
in interface ICompositeGroupService
searchForEntities
in class ReferenceCompositeGroupService
GroupsException
public EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype) throws GroupsException
ICompositeGroupService
searchForGroups
in interface ICompositeGroupService
searchForGroups
in class ReferenceCompositeGroupService
GroupsException
public EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype, IEntityGroup ancestor) throws GroupsException
ICompositeGroupService
searchForGroups
in interface ICompositeGroupService
searchForGroups
in class ReferenceCompositeGroupService
GroupsException
public void updateGroup(IEntityGroup group) throws GroupsException
updateGroup
in interface IIndividualGroupService
group
- IEntityGroup
GroupsException
public void updateGroup(ILockableEntityGroup group) throws GroupsException
ILockableEntityGroup
in the cache and the store.
updateGroup
in interface ILockableGroupService
group
- ILockableEntityGroup
GroupsException
public void updateGroup(ILockableEntityGroup group, boolean renewLock) throws GroupsException
ILockableEntityGroup
in the store and removes
it from the cache.
updateGroup
in interface ILockableGroupService
group
- ILockableEntityGroup
GroupsException
public void updateGroupMembers(IEntityGroup group) throws GroupsException
updateGroupMembers
in interface IIndividualGroupService
group
- IEntityGroup
GroupsException
public void updateGroupMembers(ILockableEntityGroup group) throws GroupsException
ILockableEntityGroup
in the cache and the store.
updateGroupMembers
in interface ILockableGroupService
group
- ILockableEntityGroup
GroupsException
public void updateGroupMembers(ILockableEntityGroup group, boolean renewLock) throws GroupsException
ILockableEntityGroup
in the store and removes
it from the cache.
updateGroupMembers
in interface ILockableGroupService
group
- ILockableEntityGroup
GroupsException
public boolean contains(IEntityGroup group, IGroupMember member) throws GroupsException
group
contains member
.
If the group belongs to another service and the present service is
not editable, simply return false.
contains
in interface IIndividualGroupService
group
- org.jasig.portal.groups.IEntityGroupmember
- org.jasig.portal.groups.IGroupMember
GroupsException
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |