com.novell.emframe.dev
Class Deletor

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

Direct Known Subclasses:

VetoDeletor, VetoServerDelete

public class Deletor

extends Plugin

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

Field Summary

protected java.lang.String	m_header Header of the message.
protected java.lang.String	m_msg Body of deletion message to display.
protected java.lang.String	m_objectName Full DN of the object to be deleted.

Constructor Summary

Deletor()

Method Summary

void	doDelete(ObjectEntry objectName, TaskContext context) Called for this deletor to delete the object.
java.lang.String	getObjectName() Returns the name of the object deleted.

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 deletion message to display.

m_objectName

protected java.lang.String m_objectName

Full DN of the object to be deleted.

Constructor Detail

Deletor

public Deletor()

Method Detail

doDelete

public void doDelete(ObjectEntry objectName,
                     TaskContext context)
              throws PluginException

Called for this deletor to delete the object.

Parameters:

objectName - ObjectEntry containing the object to be deleted

context - TaskContext of the plug-in

Throws:

PluginException - if the deletion failed or should be Vetoed

getObjectName

public java.lang.String getObjectName()

Returns the name of the object deleted.

Returns:

String containing the full DN of the object that was deleted