com.novell.emframe.dev
Class Move

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

Direct Known Subclasses:

VetoMove

public class Move

extends Plugin

Extend this class to provide a custom object mover. Your mover class with then be called when an object of the type your custom object mover is registered for needs to be moved. 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

Move()

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.
java.lang.String	getObjectName() Returns the original name of the object to be moved.

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

Move

public Move()

Method Detail

doMove

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

Called for this mover to move the object.

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.

Returns:

ObjectEntry containing the destination object

getObjectName

public java.lang.String getObjectName()

Returns the original name of the object to be moved.

Returns:

String containing the original full DN of the object that was moved