planetj.dataengine.action
Class ActionWrapper

java.lang.Object
  planetj.dataengine.action.AbstractAction
      planetj.dataengine.action.ActionWrapper

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class ActionWrapper

extends AbstractAction

This object encapsulates an action along with an action descriptor that will be used when displaying the action. This allows one action to be able to be displayed using

See Also:

Serialized Form

Field Summary

Fields inherited from class planetj.dataengine.action.AbstractAction

DEFAULT_TYPE

Constructor Summary

ActionWrapper(AbstractAction action, ActionDescriptor descriptor)
Constructor.

Method Summary

java.lang.String	getDefaultLocation() Get the default location where this action is to be generated
ActionDescriptor	getDescriptor() Get the descriptor for this action.
java.lang.String	getName() Subclasses may override if necessary.
java.lang.String	getType() Subclasses may override if necessary.
java.lang.Object	handleAction(java.lang.Object o, ExecutingContext ec) Subclasses need to provide logic to handle the action they wish to perform.
void	setDescriptor(ActionDescriptor descriptor) Set the descriptor for this action.

Methods inherited from class planetj.dataengine.action.AbstractAction

clone, cloneAction, getDefaultDescriptor, getDetailsLocations, getDetailsModes, getLocation, getLocations, handleAction, handleAction

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionWrapper

public ActionWrapper(AbstractAction action,
                     ActionDescriptor descriptor)

Constructor.

Method Detail

getDefaultLocation

public java.lang.String getDefaultLocation()

Description copied from class: AbstractAction

Get the default location where this action is to be generated

Specified by:

getDefaultLocation in class AbstractAction

Returns:

getDescriptor

public ActionDescriptor getDescriptor()

Description copied from class: AbstractAction

Get the descriptor for this action. The descriptor is how the action is to be displayed.

Overrides:

getDescriptor in class AbstractAction

Returns:

setDescriptor

public void setDescriptor(ActionDescriptor descriptor)

Description copied from class: AbstractAction

Set the descriptor for this action. The descriptor is how the action is to be displayed.

Overrides:

setDescriptor in class AbstractAction

Parameters:

descriptor -

getName

public java.lang.String getName()

Description copied from class: AbstractAction

Subclasses may override if necessary. Doing so will allow subclasses to have their own distinct action name

Specified by:

getName in class AbstractAction

getType

public java.lang.String getType()

Description copied from class: AbstractAction

Subclasses may override if necessary. Doing so will allow subclasses to have their own distinct property group descriptors.

Overrides:

getType in class AbstractAction

handleAction

public java.lang.Object handleAction(java.lang.Object o,
                                     ExecutingContext ec)
                              throws CMException

Description copied from class: AbstractAction

Subclasses need to provide logic to handle the action they wish to perform.

Specified by:

handleAction in class AbstractAction

Parameters:

o - Object to perform the action on

Throws:

CMException