com.novell.emframe.dev
Class Rename

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

Direct Known Subclasses:

VetoRename

public class Rename

extends Plugin

Extend this class to provide a custom object renamer. Your renamer class with then be called when an object of the type your custom object renamer is registered for needs to be renamed. You must also register as an object renamer in your XML descriptor under the <object-rename> element.

Field Summary

protected java.lang.String	m_header Header of the message.
protected java.lang.String	m_msg Body of rename 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 renamed.

Constructor Summary

Rename()

Method Summary

void	doRename(ObjectEntry srcOE, java.lang.String newObjName, TaskContext context) Called for this renamer to rename 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 renamed.

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 rename 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 renamed.

Constructor Detail

Rename

public Rename()

Method Detail

doRename

public void doRename(ObjectEntry srcOE,
                     java.lang.String newObjName,
                     TaskContext context)
              throws PluginException

Called for this renamer to rename the object.

Parameters:

srcOE - ObjectEntry containing the original object to be renamed

newObjName - ObjectEntry containing the destination object

context - TaskContext of the plug-in

Throws:

PluginException - if the rename 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 renamed.

Returns:

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