planetj.dataengine.action
Class NamedRowCollectionAction

java.lang.Object
  planetj.dataengine.action.AbstractAction
      planetj.dataengine.action.ObjectAction
          planetj.dataengine.action.NamedAction
              planetj.dataengine.action.NamedRowCollectionAction

All Implemented Interfaces:

java.lang.Cloneable, IHttpAction, IRowCollectionAction, java.io.Serializable

Direct Known Subclasses:

PagingAction

public class NamedRowCollectionAction

extends NamedAction

implements IHttpAction, IRowCollectionAction

See Also:

Serialized Form

Field Summary

Fields inherited from class planetj.dataengine.action.AbstractAction

DEFAULT_TYPE

Fields inherited from interface planetj.dataengine.action.IRowCollectionAction

TYPE

Constructor Summary

NamedRowCollectionAction(java.lang.String actionName, RowCollection actionObject)

Method Summary

IActionRequest	createActionRequest(java.lang.Object o, HttpServletRequest request, HttpServletResponse response) Get a magic request that may be used to execute this action.
RowCollection	getRowCollection() Gets the RowCollection tied to this action.
java.lang.String	getType() Subclasses may override if necessary.
java.lang.Object	handleObjectAction(IActionObject ao, java.lang.Object o, ExecutingContext ec) Ensure given object to perform action on is a RowCollection.
java.lang.Object	handleRowCollectionAction(RowCollection rc, java.lang.Object o, ExecutingContext ec) Subclasses need to provide logic to handle the action they wish to perform.

Methods inherited from class planetj.dataengine.action.NamedAction

createActionRequest, getName

Methods inherited from class planetj.dataengine.action.ObjectAction

getActionObject, getCorrectAction, getDefaultLocation, getDescriptor, handleAction, isApplicable, isApplicable, setActionObject

Methods inherited from class planetj.dataengine.action.AbstractAction

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface planetj.dataengine.action.IHttpAction

createActionRequest

Constructor Detail

NamedRowCollectionAction

public NamedRowCollectionAction(java.lang.String actionName,
                                RowCollection actionObject)

Method Detail

createActionRequest

public IActionRequest createActionRequest(java.lang.Object o,
                                          HttpServletRequest request,
                                          HttpServletResponse response)
                                   throws CMException

Description copied from interface: IHttpAction

Get a magic request that may be used to execute this action.

Specified by:

createActionRequest in interface IHttpAction

Throws:

CMException

getRowCollection

public RowCollection getRowCollection()

Gets the RowCollection tied to this action.

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

handleObjectAction

public final java.lang.Object handleObjectAction(IActionObject ao,
                                                 java.lang.Object o,
                                                 ExecutingContext ec)
                                          throws CMException

Ensure given object to perform action on is a RowCollection.

Overrides:

handleObjectAction in class ObjectAction

Parameters:

o - Object to perform the action on

Throws:

CMException

handleRowCollectionAction

public java.lang.Object handleRowCollectionAction(RowCollection rc,
                                                  java.lang.Object o,
                                                  ExecutingContext ec)
                                           throws CMException

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

Parameters:

rc - RowCollection to perform action on

Throws:

CMException