org.sakaiproject.api.common.agent
Interface Group

All Superinterfaces:
Agent, Persistable, Typeable
All Known Implementing Classes:
GroupBean

public interface Group
extends Agent

Group extends Agent so that it too can be a target to which permissions are assigned. Groups add to the Agent model by including a collection of Agents.

Since:
Sakai 2.0
Version:
$Id: Group.java 632 2005-07-14 21:22:50Z janderse@umich.edu $
Author:
Lance Speelmon

Method Summary
 Set getMembers()
          This method gives the caller "raw" access directly to the underlying collection which backs the Group's membership.
 void setMembers(Set members)
          This method would be used in edge cases where the caller would want to completely replace an existing Group's membership with a new Set.
 
Methods inherited from interface org.sakaiproject.api.common.agent.Agent
getDisplayName, getEnterpriseId, getSessionManagerUserId, getSortName, setDisplayName, setEnterpriseId, setSessionManagerUserId, setSortName
 
Methods inherited from interface org.sakaiproject.api.common.manager.Persistable
getCreatedBy, getCreatedDate, getLastModifiedBy, getLastModifiedDate, getUuid
 
Methods inherited from interface org.sakaiproject.api.common.type.Typeable
getType, setType
 

Method Detail

getMembers

public Set getMembers()
This method gives the caller "raw" access directly to the underlying collection which backs the Group's membership.

Returns:
Returns the members.

setMembers

public void setMembers(Set members)
This method would be used in edge cases where the caller would want to completely replace an existing Group's membership with a new Set. Normally, the caller would get the Set from getMembers() method and mutate that Set, then persist the changes to the Group's membership by calling AgentGroupManager.save(Agent).

Parameters:
members -