|
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.GroupMemberImpl
GroupMemberImpl summary first sentence goes here.
IGroupMember
Constructor Summary | |
GroupMemberImpl(EntityIdentifier newEntityIdentifier)
GroupMemberImpl constructor |
|
GroupMemberImpl(java.lang.String key,
java.lang.Class type)
GroupMemberImpl constructor |
Method Summary | |
void |
addGroup(IEntityGroup eg)
Adds the key of the IEntityGroup to our Set of group keys
by copying the keys, updating the copy, and replacing the old keys with the copy. |
boolean |
contains(IGroupMember gm)
Default implementation, overridden on EntityGroupImpl. |
boolean |
deepContains(IGroupMember gm)
Default implementation, overridden on EntityGroupImpl. |
java.util.Iterator |
getAllContainingGroups()
Returns an Iterator over the Set of this
IGroupMember's recursively-retrieved parent groups. |
java.util.Iterator |
getAllEntities()
Default implementation, overridden on EntityGroupImpl. |
java.util.Iterator |
getAllMembers()
Default implementation, overridden on EntityGroupImpl. |
java.util.Iterator |
getContainingGroups()
Returns an Iterator over this IGroupMember's parent groups. |
java.util.Iterator |
getEntities()
Default implementation, overridden on EntityGroupImpl. |
java.lang.String |
getKey()
Returns the key of the underlying entity. |
IEntityGroup |
getMemberGroupNamed(java.lang.String name)
Default implementation, overridden on EntityGroupImpl. |
java.util.Iterator |
getMembers()
Default implementation, overridden on EntityGroupImpl. |
java.lang.Class |
getType()
Returns the type of the underlying entity. |
EntityIdentifier |
getUnderlyingEntityIdentifier()
Returns EntityIdentifier for this IGroupMember's
underlying entity. |
int |
hashCode()
|
boolean |
hasMembers()
Default implementation, overridden on EntityGroupImpl. |
boolean |
isDeepMemberOf(IGroupMember gm)
Answers if this IGroupMember is, recursively, a member of IGroupMember gm. |
boolean |
isEntity()
|
boolean |
isGroup()
|
boolean |
isMemberOf(IGroupMember gm)
Answers if this IGroupMember is a member of IGroupMember gm. |
void |
removeGroup(IEntityGroup eg)
Removes the key of the IEntityGroup from our Set of group keys
by copying the keys, updating the copy, and replacing the old keys with the copy. |
Methods inherited from class java.lang.Object |
equals, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.jasig.portal.groups.IGroupMember |
equals, getEntityType, getLeafType |
Methods inherited from interface org.jasig.portal.IBasicEntity |
getEntityIdentifier |
Constructor Detail |
public GroupMemberImpl(java.lang.String key, java.lang.Class type) throws GroupsException
public GroupMemberImpl(EntityIdentifier newEntityIdentifier) throws GroupsException
Method Detail |
public void addGroup(IEntityGroup eg) throws GroupsException
IEntityGroup
to our Set
of group keys
by copying the keys, updating the copy, and replacing the old keys with the copy.
This lets us confine synchronization to the getter and setter methods for the keys.
eg
- org.jasig.portal.groups.IEntityGroup
GroupsException
public boolean contains(IGroupMember gm) throws GroupsException
contains
in interface IGroupMember
gm
- org.jasig.portal.groups.IGroupMember
GroupsException
public boolean deepContains(IGroupMember gm) throws GroupsException
deepContains
in interface IGroupMember
gm
- org.jasig.portal.groups.IGroupMember
GroupsException
public java.util.Iterator getAllContainingGroups() throws GroupsException
Iterator
over the Set
of this
IGroupMember's
recursively-retrieved parent groups.
getAllContainingGroups
in interface IGroupMember
GroupsException
public java.util.Iterator getAllEntities() throws GroupsException
getAllEntities
in interface IGroupMember
GroupsException
public java.util.Iterator getAllMembers() throws GroupsException
getAllMembers
in interface IGroupMember
GroupsException
public java.util.Iterator getContainingGroups() throws GroupsException
Iterator
over this IGroupMember's
parent groups.
Synchronize the collection of keys with adds and removes.
getContainingGroups
in interface IGroupMember
GroupsException
public java.util.Iterator getEntities() throws GroupsException
getEntities
in interface IGroupMember
GroupsException
public java.lang.String getKey()
IGroupMember
getKey
in interface IGroupMember
public IEntityGroup getMemberGroupNamed(java.lang.String name) throws GroupsException
getMemberGroupNamed
in interface IGroupMember
name
- java.lang.String
GroupsException
public java.util.Iterator getMembers() throws GroupsException
getMembers
in interface IGroupMember
GroupsException
public java.lang.Class getType()
IGroupMember
IEntityGroup
. For an entity, it will be the type of the
underlying EntityIdentifier
.
getType
in interface IGroupMember
public EntityIdentifier getUnderlyingEntityIdentifier()
IGroupMember
EntityIdentifier
for this IGroupMember's
underlying entity. In the case of an IEntityGroup
, it will
be the EntityIdentifier
for this
. In the case
of an IEntity
, it will be the EntityIdentifier
that identifies the underlying IPerson, ChannelDefinition, etc.
getUnderlyingEntityIdentifier
in interface IGroupMember
public int hashCode()
hashCode
in interface IGroupMember
public boolean hasMembers() throws GroupsException
hasMembers
in interface IGroupMember
GroupsException
public boolean isDeepMemberOf(IGroupMember gm) throws GroupsException
IGroupMember
is, recursively, a member of IGroupMember
gm.
isDeepMemberOf
in interface IGroupMember
gm
- org.jasig.portal.groups.IGroupMember
GroupsException
public boolean isEntity()
isEntity
in interface IGroupMember
public boolean isGroup()
isGroup
in interface IGroupMember
public boolean isMemberOf(IGroupMember gm) throws GroupsException
IGroupMember
is a member of IGroupMember
gm.
isMemberOf
in interface IGroupMember
gm
- org.jasig.portal.groups.IGroupMember
GroupsException
public void removeGroup(IEntityGroup eg) throws GroupsException
IEntityGroup
from our Set
of group keys
by copying the keys, updating the copy, and replacing the old keys with the copy.
This lets us confine synchronization to the getter and setter methods for the keys.
eg
- 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 |