|
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.channels.groupsmanager.SearchResultsGroupImpl
SearchResultsGroupImp summary description sentence goes here.
Constructor Summary | |
SearchResultsGroupImpl(java.lang.Class leafType)
|
Method Summary | |
void |
addMember(IGroupMember gm)
Adds IGroupMember gm to this group, but does not commit it to the
data store. |
boolean |
contains(IGroupMember gm)
Answers if IGroupMember gm is a member of this . |
boolean |
deepContains(IGroupMember gm)
Answers if IGroupMember gm is a recursive member of this . |
void |
delete()
Deletes the IEntityGroup from the data store. |
boolean |
equals(java.lang.Object o)
Answers if Object o is an IGroupMember that refers to the same underlying
entity(ies) as this . |
java.util.Iterator |
getAllContainingGroups()
Returns an Iterator over the Set of this
IGroupMember's recursively-retrieved parent groups. |
java.util.Iterator |
getAllEntities()
Returns an Iterator over the Set of this
IGroupMember's recursively-retrieved members that are
IEntities . |
java.util.Iterator |
getAllMembers()
Returns an Iterator over the Set of recursively-retrieved
IGroupMembers that are members of this . |
java.util.Iterator |
getContainingGroups()
Returns an Iterator over this IGroupMember's parent groups. |
java.lang.String |
getCreatorID()
Returns the name of the group creator. |
java.lang.String |
getDescription()
Returns the group description, which may be null. |
java.util.Iterator |
getEntities()
Returns an Iterator over this IGroupMember's
members that are IEntities . |
EntityIdentifier |
getEntityIdentifier()
|
java.lang.Class |
getEntityType()
Returns the underlying entity type. |
java.lang.String |
getKey()
Returns the key of the underlying entity. |
java.lang.Class |
getLeafType()
|
java.lang.String |
getLocalKey()
Returns the key from the group service of origin. |
IEntityGroup |
getMemberGroupNamed(java.lang.String name)
Returns the named IEntityGroup from our members Collection . |
java.util.Iterator |
getMembers()
Returns an Iterator over the IGroupMembers in our
member Collection . |
java.lang.String |
getName()
Returns the group name. |
javax.naming.Name |
getServiceName()
Returns the Name of the group service of origin. |
java.lang.Class |
getType()
Returns the type of the underlying entity. |
EntityIdentifier |
getUnderlyingEntityIdentifier()
Returns EntityIdentifier for this IGroupMember's
underlying entity. |
boolean |
hasMembers()
Answers if this IGroupMember has any members. |
boolean |
isDeepMemberOf(IGroupMember gm)
Answers if this is a recursive member of IGroupMember gm. |
boolean |
isEditable()
Answers if this IEntityGroup can be changed or deleted. |
boolean |
isEntity()
|
boolean |
isGroup()
|
boolean |
isMemberOf(IGroupMember gm)
Answers if this is a member of IGroupMember gm. |
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 class java.lang.Object |
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.jasig.portal.groups.IGroupMember |
hashCode |
Constructor Detail |
public SearchResultsGroupImpl(java.lang.Class leafType)
Method Detail |
public void addMember(IGroupMember gm) throws GroupsException
IEntityGroup
IGroupMember
gm to this group, but does not commit it to the
data store. Use updateMembers()
to commit memberships to the data store.
addMember
in interface IEntityGroup
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 java.util.Iterator getMembers() throws GroupsException
IGroupMember
Iterator
over the IGroupMembers
in our
member Collection
.
getMembers
in interface IGroupMember
GroupsException
public java.lang.String getCreatorID()
IEntityGroup
getCreatorID
in interface IEntityGroup
public java.lang.String getDescription()
IEntityGroup
getDescription
in interface IEntityGroup
public java.lang.String getLocalKey()
IEntityGroup
getLocalKey
in interface IEntityGroup
public java.lang.String getName()
IEntityGroup
getName
in interface IEntityGroup
public javax.naming.Name getServiceName()
IEntityGroup
getServiceName
in interface IEntityGroup
public void removeMember(IGroupMember gm)
IEntityGroup
IGroupMember
from this group, but does not remove the
membership from the data store.
removeMember
in interface IEntityGroup
gm
- org.jasig.portal.groups.IGroupMemberpublic void setCreatorID(java.lang.String userID)
setCreatorID
in interface IEntityGroup
userID
- String (required)public void setDescription(java.lang.String name)
setDescription
in interface IEntityGroup
name
- String (may be null)public void setName(java.lang.String name) throws GroupsException
IEntityGroup
setName
in interface IEntityGroup
name
- String
GroupsException
public void setLocalGroupService(IIndividualGroupService groupService) throws GroupsException
IEntityGroup
setLocalGroupService
in interface IEntityGroup
GroupsException
public boolean contains(IGroupMember gm) throws GroupsException
IGroupMember
IGroupMember
gm is a member of this
.
contains
in interface IGroupMember
gm
- org.jasig.portal.groups.IGroupMember
GroupsException
public boolean deepContains(IGroupMember gm) throws GroupsException
IGroupMember
IGroupMember
gm is a recursive member of this
.
deepContains
in interface IGroupMember
gm
- org.jasig.portal.groups.IGroupMember
GroupsException
public boolean equals(java.lang.Object o)
IGroupMember
IGroupMember
that refers to the same underlying
entity(ies) as this
.
equals
in interface IGroupMember
public java.util.Iterator getAllContainingGroups() throws GroupsException
IGroupMember
Iterator
over the Set
of this
IGroupMember's
recursively-retrieved parent groups.
getAllContainingGroups
in interface IGroupMember
GroupsException
public java.util.Iterator getAllEntities() throws GroupsException
IGroupMember
Iterator
over the Set
of this
IGroupMember's
recursively-retrieved members that are
IEntities
.
getAllEntities
in interface IGroupMember
GroupsException
public java.util.Iterator getAllMembers() throws GroupsException
IGroupMember
Iterator
over the Set
of recursively-retrieved
IGroupMembers
that are members of this
.
getAllMembers
in interface IGroupMember
GroupsException
public java.util.Iterator getContainingGroups() throws GroupsException
IGroupMember
Iterator
over this IGroupMember's
parent groups.
getContainingGroups
in interface IGroupMember
GroupsException
public java.util.Iterator getEntities() throws GroupsException
IGroupMember
Iterator
over this IGroupMember's
members that are IEntities
.
getEntities
in interface IGroupMember
GroupsException
public java.lang.Class getEntityType()
IGroupMember
IEntityGroup
, this is
analagous to Class
as applied to an Array
; it is an
attribute of the group object. For an IEntity
, it is the entity
type of the group the entity belongs to, which may be any Class
the underlying entity can be legally cast to. Thus, an IEntity
with an underlying entity of type Manager
could have an entity
type of Employee
as long as Employee
was a
superclass of Manager
.
getEntityType
in interface IGroupMember
public java.lang.String getKey()
IGroupMember
getKey
in interface IGroupMember
public java.lang.Class getLeafType()
getLeafType
in interface IGroupMember
IGroupMember.getEntityType()
public IEntityGroup getMemberGroupNamed(java.lang.String name) throws GroupsException
IGroupMember
IEntityGroup
from our members Collection
.
getMemberGroupNamed
in interface IGroupMember
name
- java.lang.String
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 boolean isDeepMemberOf(IGroupMember gm) throws GroupsException
IGroupMember
this
is a recursive member of IGroupMember
gm.
isDeepMemberOf
in interface IGroupMember
gm
- org.jasig.portal.groups.IGroupMember
GroupsException
public boolean isMemberOf(IGroupMember gm) throws GroupsException
IGroupMember
this
is a member of IGroupMember
gm.
isMemberOf
in interface IGroupMember
gm
- org.jasig.portal.groups.IGroupMember
GroupsException
public EntityIdentifier getEntityIdentifier()
getEntityIdentifier
in interface IBasicEntity
public void update() throws GroupsException
IEntityGroup
IEntityGroup
AND ITS MEMBERSHIPS to the data store.
update
in interface IEntityGroup
GroupsException
- if the update cannot be performed.public void updateMembers() throws GroupsException
IEntityGroup
IEntityGroup's
memberships to the data store.
updateMembers
in interface IEntityGroup
GroupsException
- if the update cannot be performed.public boolean isEditable() throws GroupsException
IEntityGroup
IEntityGroup
can be changed or deleted.
isEditable
in interface IEntityGroup
GroupsException
public void delete() throws GroupsException
IEntityGroup
IEntityGroup
from the data store.
delete
in interface IEntityGroup
GroupsException
- if the delete cannot be performed.public boolean hasMembers() throws GroupsException
IGroupMember
IGroupMember
has any members.
hasMembers
in interface IGroupMember
GroupsException
public boolean isEntity()
isEntity
in interface IGroupMember
public boolean isGroup()
isGroup
in interface IGroupMember
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |