|
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 an entry point into the groups system,
represented by an IGroupMember
. This is analogous to getting an
InitialContext
in JNDI. Subsequent requests for navigating or
maintaining groups go thru the IGroupMember
.
Method Summary | |
void |
deleteGroup(IEntityGroup group)
Removes the IEntityGroup from the store. |
java.util.Iterator |
findContainingGroups(IGroupMember gm)
Returns the containing groups for the IGroupMember |
IEntityGroup |
findGroup(java.lang.String key)
Returns a pre-existing IEntityGroup or null if the
IGroupMember does not exist. |
java.util.Iterator |
findMemberGroups(IEntityGroup eg)
Returns the member groups for the IEntityGroup |
IEntity |
getEntity(java.lang.String key,
java.lang.Class type)
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 an IEntityGroupStore . |
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)
Commits the updated IEntityGroup to the store. |
void |
updateGroupMembers(IEntityGroup group)
Commits the updated IEntityGroup to the store. |
Method Detail |
public IEntityGroup findGroup(java.lang.String key) throws GroupsException
IEntityGroup
or null if the
IGroupMember
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 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
.
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) throws GroupsException
IEntityGroup
for the given Class with an unused
key.
GroupsException
public IEntityGroupStore getGroupStore() throws GroupsException
IEntityGroupStore
.
GroupsException
public void deleteGroup(IEntityGroup group) throws GroupsException
IEntityGroup
from the store.
GroupsException
public void updateGroup(IEntityGroup group) throws GroupsException
IEntityGroup
to the store.
GroupsException
public void updateGroupMembers(IEntityGroup group) throws GroupsException
IEntityGroup
to the store.
GroupsException
public java.util.Iterator findContainingGroups(IGroupMember gm) throws GroupsException
IGroupMember
gm
- IGroupMember
GroupsException
public java.util.Iterator findMemberGroups(IEntityGroup eg) throws GroupsException
IEntityGroup
eg
- IEntityGroup
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
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
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |