com.novell.emframe.dev
Class VetoMove

java.lang.Object
  com.novell.emframe.dev.Plugin
      com.novell.emframe.dev.Move
          com.novell.emframe.dev.VetoMove

public class VetoMove

extends Move

Generic Mover that will Veto any move operation. If your custom Move decides it needs to Veto the move, extended the VetoMove class and overwrite the doMove method. Then in your doMove method when you determine you need to Veto the move, simply call the parent.doMove to Veto the move. You must also register as an object mover in your XML descriptor under the <object-move> element.

Field Summary

protected java.lang.String	m_header Header of the message.
protected java.lang.String	m_msg Body of move message to display.
protected ObjectEntry	m_newOE ObjectEntry of the new object.
protected java.lang.String	m_objectName Full DN of the object to be moved.

Constructor Summary

VetoMove()

Method Summary

void	doMove(ObjectEntry srcOE, ObjectEntry destOE, TaskContext context) Called for this mover to move the object.
ObjectEntry	getNewObjectEntry() Returns the new ObjectEntry containing the destination object.

Methods inherited from class com.novell.emframe.dev.Move

getObjectName

Methods inherited from class com.novell.emframe.dev.Plugin

init, isPluginAvailable

Methods inherited from class java.lang.Object

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

Field Detail

m_header

protected java.lang.String m_header

Header of the message.

m_msg

protected java.lang.String m_msg

Body of move message to display.

m_newOE

protected ObjectEntry m_newOE

ObjectEntry of the new object.

m_objectName

protected java.lang.String m_objectName

Full DN of the object to be moved.

Constructor Detail

VetoMove

public VetoMove()

Method Detail

doMove

public void doMove(ObjectEntry srcOE,
                   ObjectEntry destOE,
                   TaskContext context)
            throws PluginException

Called for this mover to move the object. This method will always throw a PluginException.

Overrides:

doMove in class Move

Parameters:

srcOE - ObjectEntry containing the original object to be moved

destOE - ObjectEntry containing the destination object

context - TaskContext of the plug-in

Throws:

PluginException - if the move failed or should be Vetoed

getNewObjectEntry

public ObjectEntry getNewObjectEntry()

Returns the new ObjectEntry containing the destination object.

Overrides:

getNewObjectEntry in class Move

Returns:

ObjectEntry containing the destination object