com.metamatrix.common.actions
Class RemoveNamedObject

java.lang.Object
  com.metamatrix.common.actions.ActionDefinition
      com.metamatrix.common.actions.TargetedActionDefinition
          com.metamatrix.common.actions.RemoveObject
              com.metamatrix.common.actions.RemoveNamedObject

All Implemented Interfaces:

NamedObjectActionDefinition, java.io.Serializable, java.lang.Cloneable

public class RemoveNamedObject
extends RemoveObject
implements NamedObjectActionDefinition

This action definition specifies that a named object is to be removed from the target.

See Also:

Serialized Form

Constructor Summary

	RemoveNamedObject(java.lang.Object target, AttributeDefinition attribute, java.lang.Object[] args)
	RemoveNamedObject(java.lang.Object target, AttributeDefinition attribute, java.lang.String name, java.lang.Object object)
protected	RemoveNamedObject(java.lang.Object target, java.lang.Integer attributeCode, java.lang.Object[] args)

Method Summary

java.lang.Object	clone() Return a deep cloned instance of this object.
java.lang.String	getActionDescription() Get the description (i.e., verb) for this type of action.
java.lang.String	getName()
ActionDefinition	getUndoActionDefinition() Obtain the definition of the action that undoes this action definition.
void	setName(java.lang.String newName)

Methods inherited from class com.metamatrix.common.actions.RemoveObject

toString

Methods inherited from class com.metamatrix.common.actions.ActionDefinition

getArguments, getAttributeCode, getAttributeDescription, getCreationTime, getCreationTimeMillis, getTarget, hasArguments, hasAttributeCode, hasTarget

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoveNamedObject

public RemoveNamedObject(java.lang.Object target,
                         AttributeDefinition attribute,
                         java.lang.String name,
                         java.lang.Object object)

RemoveNamedObject

public RemoveNamedObject(java.lang.Object target,
                         AttributeDefinition attribute,
                         java.lang.Object[] args)

RemoveNamedObject

protected RemoveNamedObject(java.lang.Object target,
                            java.lang.Integer attributeCode,
                            java.lang.Object[] args)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface NamedObjectActionDefinition

getActionDescription

public java.lang.String getActionDescription()

Description copied from class: ActionDefinition

Get the description (i.e., verb) for this type of action.

Overrides:

getActionDescription in class RemoveObject

Returns:

the string description for this type of action.

setName

public void setName(java.lang.String newName)

Specified by:

setName in interface NamedObjectActionDefinition

clone

public java.lang.Object clone()

Return a deep cloned instance of this object. Subclasses must override this method.

Overrides:

clone in class RemoveObject

Returns:

the object that is the clone of this instance.

getUndoActionDefinition

public ActionDefinition getUndoActionDefinition()

Obtain the definition of the action that undoes this action definition. If a modification action with the returned action definition is applied to the same target (when the state is such as that left by the original modification action), the resulting target will be left in a state that is identical to the target before either action were applied.

Overrides:

getUndoActionDefinition in class RemoveObject

Returns:

the action definition that undoes this action definition.