org.jasig.portal.channels.groupsmanager
Class SearchResultsGroupImpl

java.lang.Object
  org.jasig.portal.channels.groupsmanager.SearchResultsGroupImpl

All Implemented Interfaces:

IEntityGroup, IGroupMember, IBasicEntity

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class SearchResultsGroupImpl
extends Object
implements IEntityGroup

SearchResultsGroupImp summary description sentence goes here.

Version:

$Revision: 19776 $

Field Summary

protected String	creator Deprecated.
protected String	description Deprecated.
protected EntityIdentifier	ei Deprecated.
protected Class	leafType Deprecated.
protected ArrayList	members Deprecated.
protected String	name Deprecated.

Constructor Summary

SearchResultsGroupImpl(Class leafType)
Deprecated.

Method Summary

void	addMember(IGroupMember gm) Deprecated. Adds IGroupMember gm to this group, but does not commit it to the data store.
boolean	contains(IGroupMember gm) Deprecated. Answers if IGroupMember gm is a member of this.
boolean	deepContains(IGroupMember gm) Deprecated. Answers if IGroupMember gm is a recursive member of this.
void	delete() Deprecated. Deletes the IEntityGroup from the data store.
boolean	equals(Object o) Deprecated. Answers if Object o is an IGroupMember that refers to the same underlying entity(ies) as this.
Iterator	getAllContainingGroups() Deprecated. Returns an Iterator over the Set of this IGroupMember's recursively-retrieved parent groups.
Iterator	getAllEntities() Deprecated. Returns an Iterator over the Set of this IGroupMember's recursively-retrieved members that are IEntities.
Iterator	getAllMembers() Deprecated. Returns an Iterator over the Set of recursively-retrieved IGroupMembers that are members of this.
Iterator	getContainingGroups() Deprecated. Returns an Iterator over this IGroupMember's parent groups.
String	getCreatorID() Deprecated. Returns the name of the group creator.
String	getDescription() Deprecated. Returns the group description, which may be null.
Iterator	getEntities() Deprecated. Returns an Iterator over this IGroupMember's members that are IEntities.
EntityIdentifier	getEntityIdentifier() Deprecated.
Class	getEntityType() Deprecated. Returns the underlying entity type.
String	getKey() Deprecated. Returns the key of the underlying entity.
Class	getLeafType() Deprecated.
String	getLocalKey() Deprecated. Returns the key from the group service of origin.
IEntityGroup	getMemberGroupNamed(String name) Deprecated. Returns the named IEntityGroup from our members Collection.
Iterator	getMembers() Deprecated. Returns an Iterator over the IGroupMembers in our member Collection.
String	getName() Deprecated. Returns the group name.
Name	getServiceName() Deprecated. Returns the Name of the group service of origin.
Class	getType() Deprecated. Returns the type of the underlying entity.
EntityIdentifier	getUnderlyingEntityIdentifier() Deprecated. Returns EntityIdentifier for this IGroupMember's underlying entity.
boolean	hasMembers() Deprecated. Answers if this IGroupMember has any members.
boolean	isDeepMemberOf(IGroupMember gm) Deprecated. Answers if this is a recursive member of IGroupMember gm.
boolean	isEditable() Deprecated. Answers if this IEntityGroup can be changed or deleted.
boolean	isEntity() Deprecated.
boolean	isGroup() Deprecated.
boolean	isMemberOf(IGroupMember gm) Deprecated. Answers if this is a member of IGroupMember gm.
void	removeMember(IGroupMember gm) Deprecated. Removes the IGroupMember from this group, but does not remove the membership from the data store.
void	setCreatorID(String userID) Deprecated.
void	setDescription(String name) Deprecated.
void	setLocalGroupService(IIndividualGroupService groupService) Deprecated. Sets the group service of origin.
void	setName(String name) Deprecated. Sets the group name which must be unique within any of its containing groups.
void	update() Deprecated. Commit the IEntityGroup AND ITS MEMBERSHIPS to the data store.
void	updateMembers() Deprecated. Commit this IEntityGroup's memberships to the data store.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jasig.portal.groups.IGroupMember

hashCode

Field Detail

members

protected ArrayList members

Deprecated.

name

protected String name

Deprecated.

description

protected String description

Deprecated.

creator

protected String creator

Deprecated.

ei

protected EntityIdentifier ei

Deprecated.

leafType

protected Class leafType

Deprecated.

Constructor Detail

SearchResultsGroupImpl

public SearchResultsGroupImpl(Class leafType)

Deprecated.

Method Detail

addMember

public void addMember(IGroupMember gm)
               throws GroupsException

Deprecated.

Description copied from interface: IEntityGroup

Adds IGroupMember gm to this group, but does not commit it to the data store. Use updateMembers() to commit memberships to the data store.

Specified by:

addMember in interface IEntityGroup

Parameters:

gm - org.jasig.portal.groups.IGroupMember

Throws:

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.

getMembers

public Iterator getMembers()
                    throws GroupsException

Deprecated.

Description copied from interface: IGroupMember

Returns an Iterator over the IGroupMembers in our member Collection.

Specified by:

getMembers in interface IGroupMember

Returns:

java.util.Iterator

Throws:

GroupsException

getCreatorID

public String getCreatorID()

Deprecated.

Description copied from interface: IEntityGroup

Returns the name of the group creator. May be null.

Specified by:

getCreatorID in interface IEntityGroup

Returns:

String

getDescription

public String getDescription()

Deprecated.

Description copied from interface: IEntityGroup

Returns the group description, which may be null.

Specified by:

getDescription in interface IEntityGroup

Returns:

String

getLocalKey

public String getLocalKey()

Deprecated.

Description copied from interface: IEntityGroup

Returns the key from the group service of origin.

Specified by:

getLocalKey in interface IEntityGroup

Returns:

String

getName

public String getName()

Deprecated.

Description copied from interface: IEntityGroup

Returns the group name.

Specified by:

getName in interface IEntityGroup

Returns:

String

getServiceName

public Name getServiceName()

Deprecated.

Description copied from interface: IEntityGroup

Returns the Name of the group service of origin.

Specified by:

getServiceName in interface IEntityGroup

Returns:

String

removeMember

public void removeMember(IGroupMember gm)

Deprecated.

Description copied from interface: IEntityGroup

Removes the IGroupMember from this group, but does not remove the membership from the data store.

Specified by:

removeMember in interface IEntityGroup

Parameters:

gm - org.jasig.portal.groups.IGroupMember

setCreatorID

public void setCreatorID(String userID)

Deprecated.

Specified by:

setCreatorID in interface IEntityGroup

Parameters:

userID - String (required)

setDescription

public void setDescription(String name)

Deprecated.

Specified by:

setDescription in interface IEntityGroup

Parameters:

name - String (may be null)

setName

public void setName(String name)
             throws GroupsException

Deprecated.

Description copied from interface: IEntityGroup

Sets the group name which must be unique within any of its containing groups.

Specified by:

setName in interface IEntityGroup

Parameters:

name - String

Throws:

GroupsException

setLocalGroupService

public void setLocalGroupService(IIndividualGroupService groupService)
                          throws GroupsException

Deprecated.

Description copied from interface: IEntityGroup

Sets the group service of origin.

Specified by:

setLocalGroupService in interface IEntityGroup

Throws:

GroupsException

contains

public boolean contains(IGroupMember gm)
                 throws GroupsException

Deprecated.

Description copied from interface: IGroupMember

Answers if IGroupMember gm is a member of this.

Specified by:

contains in interface IGroupMember

Parameters:

gm - org.jasig.portal.groups.IGroupMember

Returns:

boolean

Throws:

GroupsException

deepContains

public boolean deepContains(IGroupMember gm)
                     throws GroupsException

Deprecated.

Description copied from interface: IGroupMember

Answers if IGroupMember gm is a recursive member of this.

Specified by:

deepContains in interface IGroupMember

Parameters:

gm - org.jasig.portal.groups.IGroupMember

Returns:

boolean

Throws:

GroupsException

equals

public boolean equals(Object o)

Deprecated.

Description copied from interface: IGroupMember

Answers if Object o is an IGroupMember that refers to the same underlying entity(ies) as this.

Specified by:

equals in interface IGroupMember

Overrides:

equals in class Object

Returns:

boolean

getAllContainingGroups

public Iterator getAllContainingGroups()
                                throws GroupsException

Deprecated.

Description copied from interface: IGroupMember

Returns an Iterator over the Set of this IGroupMember's recursively-retrieved parent groups.

Specified by:

getAllContainingGroups in interface IGroupMember

Returns:

java.util.Iterator

Throws:

GroupsException

getAllEntities

public Iterator getAllEntities()
                        throws GroupsException

Deprecated.

Description copied from interface: IGroupMember

Returns an Iterator over the Set of this IGroupMember's recursively-retrieved members that are IEntities.

Specified by:

getAllEntities in interface IGroupMember

Returns:

java.util.Iterator

Throws:

GroupsException

getAllMembers

public Iterator getAllMembers()
                       throws GroupsException

Deprecated.

Description copied from interface: IGroupMember

Returns an Iterator over the Set of recursively-retrieved IGroupMembers that are members of this.

Specified by:

getAllMembers in interface IGroupMember

Returns:

java.util.Iterator

Throws:

GroupsException

getContainingGroups

public Iterator getContainingGroups()
                             throws GroupsException

Deprecated.

Description copied from interface: IGroupMember

Returns an Iterator over this IGroupMember's parent groups.

Specified by:

getContainingGroups in interface IGroupMember

Returns:

java.util.Iterator

Throws:

GroupsException

getEntities

public Iterator getEntities()
                     throws GroupsException

Deprecated.

Description copied from interface: IGroupMember

Returns an Iterator over this IGroupMember's members that are IEntities.

Specified by:

getEntities in interface IGroupMember

Returns:

java.util.Iterator

Throws:

GroupsException

getEntityType

public Class getEntityType()

Deprecated.

Description copied from interface: IGroupMember

Returns the underlying entity type. For an 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.

Specified by:

getEntityType in interface IGroupMember

Returns:

java.lang.Class

getKey

public String getKey()

Deprecated.

Description copied from interface: IGroupMember

Returns the key of the underlying entity.

Specified by:

getKey in interface IGroupMember

Returns:

String

getLeafType

public Class getLeafType()

Deprecated.

Specified by:

getLeafType in interface IGroupMember

See Also:

IGroupMember.getEntityType()

getMemberGroupNamed

public IEntityGroup getMemberGroupNamed(String name)
                                 throws GroupsException

Deprecated.

Description copied from interface: IGroupMember

Returns the named IEntityGroup from our members Collection.

Specified by:

getMemberGroupNamed in interface IGroupMember

Parameters:

name - java.lang.String

Returns:

org.jasig.portal.groups.IEntityGroup

Throws:

GroupsException

getType

public Class getType()

Deprecated.

Description copied from interface: IGroupMember

Returns the type of the underlying entity. For a group this will be IEntityGroup. For an entity, it will be the type of the underlying EntityIdentifier.

Specified by:

getType in interface IGroupMember

Returns:

java.lang.Class

getUnderlyingEntityIdentifier

public EntityIdentifier getUnderlyingEntityIdentifier()

Deprecated.

Description copied from interface: IGroupMember

Returns 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.

Specified by:

getUnderlyingEntityIdentifier in interface IGroupMember

Returns:

org.jasig.portal.EntityIdentifier

isDeepMemberOf

public boolean isDeepMemberOf(IGroupMember gm)
                       throws GroupsException

Deprecated.

Description copied from interface: IGroupMember

Answers if this is a recursive member of IGroupMember gm.

Specified by:

isDeepMemberOf in interface IGroupMember

Parameters:

gm - org.jasig.portal.groups.IGroupMember

Returns:

boolean

Throws:

GroupsException

isMemberOf

public boolean isMemberOf(IGroupMember gm)
                   throws GroupsException

Deprecated.

Description copied from interface: IGroupMember

Answers if this is a member of IGroupMember gm.

Specified by:

isMemberOf in interface IGroupMember

Parameters:

gm - org.jasig.portal.groups.IGroupMember

Returns:

boolean

Throws:

GroupsException

getEntityIdentifier

public EntityIdentifier getEntityIdentifier()

Deprecated.

Specified by:

getEntityIdentifier in interface IBasicEntity

Returns:

EntityIdentifier

update

public void update()
            throws GroupsException

Deprecated.

Description copied from interface: IEntityGroup

Commit the IEntityGroup AND ITS MEMBERSHIPS to the data store.

Specified by:

update in interface IEntityGroup

Throws:

GroupsException - if the update cannot be performed.

updateMembers

public void updateMembers()
                   throws GroupsException

Deprecated.

Description copied from interface: IEntityGroup

Commit this IEntityGroup's memberships to the data store.

Specified by:

updateMembers in interface IEntityGroup

Throws:

GroupsException - if the update cannot be performed.

isEditable

public boolean isEditable()
                   throws GroupsException

Deprecated.

Description copied from interface: IEntityGroup

Answers if this IEntityGroup can be changed or deleted.

Specified by:

isEditable in interface IEntityGroup

Returns:

boolean

Throws:

GroupsException

delete

public void delete()
            throws GroupsException

Deprecated.

Description copied from interface: IEntityGroup

Deletes the IEntityGroup from the data store.

Specified by:

delete in interface IEntityGroup

Throws:

GroupsException - if the delete cannot be performed.

hasMembers

public boolean hasMembers()
                   throws GroupsException

Deprecated.

Description copied from interface: IGroupMember

Answers if this IGroupMember has any members.

Specified by:

hasMembers in interface IGroupMember

Returns:

boolean

Throws:

GroupsException

isEntity

public boolean isEntity()

Deprecated.

Specified by:

isEntity in interface IGroupMember

Returns:

boolean

isGroup

public boolean isGroup()

Deprecated.

Specified by:

isGroup in interface IGroupMember

Returns:

boolean