|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface for finding and maintaining IEntityGroups
.
Field Summary |
Fields inherited from interface org.jasig.portal.groups.IGroupConstants |
CHANNEL_CATEGORIES, CONTAINS, ENDS_WITH, EVERYONE, IS, NODE_SEPARATOR, PORTAL_ADMINISTRATORS, STARTS_WITH |
Method Summary | |
boolean |
contains(IEntityGroup group,
IGroupMember member)
Answers if group contains member . |
void |
delete(IEntityGroup group)
Delete this IEntityGroup from the data store. |
IEntityGroup |
find(java.lang.String key)
Returns an instance of the IEntityGroup from the data store. |
java.util.Iterator |
findContainingGroups(IGroupMember gm)
Returns an Iterator over the Collection of
IEntityGroups that the IGroupMember belongs to. |
java.util.Iterator |
findEntitiesForGroup(IEntityGroup group)
Returns an Iterator over the Collection of
IEntities that are members of this IEntityGroup . |
ILockableEntityGroup |
findLockable(java.lang.String key)
Returns an instance of the ILockableEntityGroup from the data store. |
java.lang.String[] |
findMemberGroupKeys(IEntityGroup group)
Returns a String[] containing the keys of IEntityGroups
that are members of this IEntityGroup . |
java.util.Iterator |
findMemberGroups(IEntityGroup group)
Returns an Iterator over the Collection of
IEntityGroups that are members of this IEntityGroup . |
IEntityGroup |
newInstance(java.lang.Class entityType)
|
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 |
void |
update(IEntityGroup group)
Adds or updates the IEntityGroup AND ITS MEMBERSHIPS to the
data store, as appropriate. |
void |
updateMembers(IEntityGroup group)
Commits the group memberships of the IEntityGroup to
the data store. |
Method Detail |
public boolean contains(IEntityGroup group, IGroupMember member) throws GroupsException
group
contains member
.
group
- org.jasig.portal.groups.IEntityGroupmember
- org.jasig.portal.groups.IGroupMember
GroupsException
public void delete(IEntityGroup group) throws GroupsException
IEntityGroup
from the data store.
group
- org.jasig.portal.groups.IEntityGroup
GroupsException
public IEntityGroup find(java.lang.String key) throws GroupsException
IEntityGroup
from the data store.
key
- java.lang.String
GroupsException
public java.util.Iterator findContainingGroups(IGroupMember gm) throws GroupsException
Iterator
over the Collection
of
IEntityGroups
that the IGroupMember
belongs to.
gm
- org.jasig.portal.groups.IEntityGroup
GroupsException
public java.util.Iterator findEntitiesForGroup(IEntityGroup group) throws GroupsException
Iterator
over the Collection
of
IEntities
that are members of this IEntityGroup
.
group
- org.jasig.portal.groups.IEntityGroup
GroupsException
public ILockableEntityGroup findLockable(java.lang.String key) throws GroupsException
ILockableEntityGroup
from the data store.
key
- java.lang.String
GroupsException
public java.lang.String[] findMemberGroupKeys(IEntityGroup group) throws GroupsException
String[]
containing the keys of IEntityGroups
that are members of this IEntityGroup
. In a composite group
system, a group may contain a member group from a different service. This is
called a foreign membership, and is only possible in an internally-managed
service. A group store in such a service can return the key of a foreign member
group, but not the group itself, which can only be returned by its local store.
group
- org.jasig.portal.groups.IEntityGroup
GroupsException
public java.util.Iterator findMemberGroups(IEntityGroup group) throws GroupsException
Iterator
over the Collection
of
IEntityGroups
that are members of this IEntityGroup
.
group
- org.jasig.portal.groups.IEntityGroup
GroupsException
public IEntityGroup newInstance(java.lang.Class entityType) throws GroupsException
GroupsException
public EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype) throws GroupsException
GroupsException
public void update(IEntityGroup group) throws GroupsException
IEntityGroup
AND ITS MEMBERSHIPS to the
data store, as appropriate.
group
- org.jasig.portal.groups.IEntityGroup
GroupsException
public void updateMembers(IEntityGroup group) throws GroupsException
IEntityGroup
to
the data store.
group
- org.jasig.portal.groups.IEntityGroup
GroupsException
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |