edu.internet2.middleware.grouper
Class GroupMove

java.lang.Object
  extended by edu.internet2.middleware.grouper.GroupMove

public class GroupMove
extends Object

Use this class to move a group to another stem.

Author:
shilen $Id: GroupMove.java,v 1.3 2009-03-29 21:17:21 shilen Exp $

Constructor Summary
GroupMove(Group group, Stem stem)
          Create a new instance of this class if you would like to specify specific options for a group move.
 
Method Summary
 GroupMove assignAlternateName(boolean value)
          Whether to add the current name of the group to the group's alternate names list.
 void save()
          Move the group using the options set in this class.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupMove

public GroupMove(Group group,
                 Stem stem)
Create a new instance of this class if you would like to specify specific options for a group move. After setting the options, call save().

Parameters:
group - Group to move
stem - Stem where group should be moved
Method Detail

assignAlternateName

public GroupMove assignAlternateName(boolean value)
Whether to add the current name of the group to the group's alternate names list. Certain operations like group name queries (GroupFinder.findByName()) will find groups by their current and alternate names. Currently, Grouper only supports one alternate name per group, so if groups are moved/renamed multiple times, only the last name will be kept as an alternate name. Default is true.

Parameters:
value -
Returns:
GroupMove

save

public void save()
          throws GroupModifyException,
                 InsufficientPrivilegeException
Move the group using the options set in this class.

Throws:
GroupModifyException
InsufficientPrivilegeException