edu.internet2.middleware.grouper
Class StemMove

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

public class StemMove
extends java.lang.Object

Use this class to move a stem to another stem.

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

Constructor Summary
StemMove(Stem stemToMove, Stem destinationStem)
          Create a new instance of this class if you would like to specify specific options for a stem move.
 
Method Summary
 StemMove assignAlternateName(boolean value)
          Whether to add the current name of the affected groups to the groups' alternate names list.
 void save()
          Move the stem 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

StemMove

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

Parameters:
stemToMove - Stem to move
destinationStem - Stem where the stem should be moved
Method Detail

assignAlternateName

public StemMove assignAlternateName(boolean value)
Whether to add the current name of the affected groups to the groups' 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:
StemMove

save

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

Throws:
StemModifyException
InsufficientPrivilegeException