|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An IEntityGroup
is a composite, or non-leaf IGroupMember
.
It contains IEntities
and other IEntityGroups
.
The api defines methods for adding a member to, and removing it from, a group,
though not vice versa. (Although there is nothing to prevent a given IGroupMember
implementation from storing references to its containing groups.) These methods only
change the group structure in memory.
addMember(IGroupMember gm)
removeMember(IGroupMember gm)
The following methods commit changes in the group structure to the persistent store:
delete()
- delete the group and its memberships
update()
- insert or update the group, as appropriate
updateMembers()
- insert/update/delete group memberships as appropriate
The following methods were added to permit an IEntityGroup
to function
within a composite group service:
getLocalKey()
- returns the key within the service of origin.
getServiceName()
- returns the Name of the group service of origin.
setLocalGroupService()
- sets the group service of origin.
Method Summary | |
void |
addMember(IGroupMember gm)
Adds IGroupMember gm to this group, but does not commit it to the
data store. |
void |
delete()
Deletes the IEntityGroup from the data store. |
java.lang.String |
getCreatorID()
Returns the name of the group creator. |
java.lang.String |
getDescription()
Returns the group description, which may be null. |
java.lang.String |
getLocalKey()
Returns the key from the group service of origin. |
java.lang.String |
getName()
Returns the group name. |
javax.naming.Name |
getServiceName()
Returns the Name of the group service of origin. |
boolean |
isEditable()
Answers if this IEntityGroup can be changed or deleted. |
void |
removeMember(IGroupMember gm)
Removes the IGroupMember from this group, but does not remove the
membership from the data store. |
void |
setCreatorID(java.lang.String userID)
|
void |
setDescription(java.lang.String name)
|
void |
setLocalGroupService(IIndividualGroupService groupService)
Sets the group service of origin. |
void |
setName(java.lang.String name)
Sets the group name which must be unique within any of its containing groups. |
void |
update()
Commit the IEntityGroup AND ITS MEMBERSHIPS to the data store. |
void |
updateMembers()
Commit this IEntityGroup's memberships to the data store. |
Methods inherited from interface org.jasig.portal.groups.IGroupMember |
contains, deepContains, equals, getAllContainingGroups, getAllEntities, getAllMembers, getContainingGroups, getEntities, getEntityType, getKey, getLeafType, getMemberGroupNamed, getMembers, getType, getUnderlyingEntityIdentifier, hashCode, hasMembers, isDeepMemberOf, isEntity, isGroup, isMemberOf |
Methods inherited from interface org.jasig.portal.IBasicEntity |
getEntityIdentifier |
Method Detail |
public void addMember(IGroupMember gm) throws GroupsException
IGroupMember
gm to this group, but does not commit it to the
data store. Use updateMembers()
to commit memberships to the data store.
gm
- org.jasig.portal.groups.IGroupMember
GroupsException
- is thrown if the member is a group and
this group already has a group with the same name or if the addition
of the group creates a circular reference.public void delete() throws GroupsException
IEntityGroup
from the data store.
GroupsException
- if the delete cannot be performed.public java.lang.String getCreatorID()
public java.lang.String getDescription()
public java.lang.String getLocalKey()
public java.lang.String getName()
public javax.naming.Name getServiceName()
public boolean isEditable() throws GroupsException
IEntityGroup
can be changed or deleted.
GroupsException
public void removeMember(IGroupMember gm) throws GroupsException
IGroupMember
from this group, but does not remove the
membership from the data store.
gm
- org.jasig.portal.groups.IGroupMember
GroupsException
public void setCreatorID(java.lang.String userID)
userID
- String (required)public void setDescription(java.lang.String name)
name
- String (may be null)public void setName(java.lang.String name) throws GroupsException
name
- String
GroupsException
public void update() throws GroupsException
IEntityGroup
AND ITS MEMBERSHIPS to the data store.
GroupsException
- if the update cannot be performed.public void updateMembers() throws GroupsException
IEntityGroup's
memberships to the data store.
GroupsException
- if the update cannot be performed.public void setLocalGroupService(IIndividualGroupService groupService) 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 |