com.sas.edir
Interface Group

All Superinterfaces:
Caching, Entity, TrackedObject

public interface Group
extends Entity

A group is an enterprise entity that contains a collection of users who share a role. A group provides:

Version:
1.0
Author:
SAS

Fields inherited from interface com.sas.edir.Entity
PROPERTY_CHANGED, SUBPROPERTY_CHANGED
 
Method Summary
 void addMember(User member)
          Adds a member to this group.
 User getOwner()
          Returns this group's owner.
 java.util.Iterator memberIterator()
          Returns an iteration of all this group's members.
 java.util.Iterator memberIterator(java.util.Comparator compare)
          Returns a sorted iteration of all this group's members.
 void removeMember(User member)
          Removes a member from this group.
 void setOwner(User owner)
          Sets this group's owner.
 
Methods inherited from interface com.sas.edir.Entity
addPropertyChangeListener, getContext, getCreateTime, getCreatorsName, getDescription, getEnterpriseDirectory, getGuid, getModifiersName, getModifyTime, getName, getObjectclass, removeModificationItems, removePropertyChangeListener, setDescription, setGuid, setName, setObjectclass
 
Methods inherited from interface com.sas.edir.Caching
edirUpdateStore, getTimeToLive, isExpired, refreshCache, refreshCachedObjects, releaseCache, setDirty, setTimeToLive, setTimeToLive, updateStore
 
Methods inherited from interface com.sas.edir.TrackedObject
getTrackingId, getUserData, setUserData
 

Method Detail

memberIterator

public java.util.Iterator memberIterator()
Returns an iteration of all this group's members.

Returns:
A User iteration.

memberIterator

public java.util.Iterator memberIterator(java.util.Comparator compare)
Returns a sorted iteration of all this group's members.

Parameters:
comparator - A Comparator for sorting, or null for no sorting.
Returns:
A User iteration.

addMember

public void addMember(User member)
Adds a member to this group.
Parameters:
member - The member to add.
Throws:
NamingException - Thrown for enterprise directory failure.

removeMember

public void removeMember(User member)
Removes a member from this group.
Parameters:
member - The member to remove.
Throws:
NamingException - Thrown for enterprise directory failure.

getOwner

public User getOwner()
Returns this group's owner.

Returns:
The owner.

setOwner

public void setOwner(User owner)
Sets this group's owner.

This change is not persisted to the enterprise directory until updateStore is called.

Parameters:
name - The owner.