public class

MojoRWManipulationTask

extends BeanTask
implements EnumDSSXMLRWManipulationMethod
java.lang.Object
   ↳ com.microstrategy.web.tasks.AbstractBaseTask
     ↳ com.microstrategy.web.app.tasks.AbstractAppTask
       ↳ com.microstrategy.web.app.tasks.WebComponentTask
         ↳ com.microstrategy.web.app.tasks.BeanTask
           ↳ com.microstrategy.web.app.tasks.MojoRWManipulationTask

Summary

Constants
String EVENT_ARG_SOURCE_PARAMETER
String EVENT_ARG_TRANSACTION_STRING
String PARAM_DESC_CHANGES
String PARAM_NAME_CHANGES
String PARAM_NAME_MESSAGE_ID
String PARAM_NAME_STATE_ID
[Expand]
Inherited Constants
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.tasks.AbstractBaseTask
From interface com.microstrategy.webapi.EnumDSSXMLRWManipulationMethod
[Expand]
Inherited Fields
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.tasks.AbstractBaseTask
Public Constructors
MojoRWManipulationTask()
Public Methods
void processRequest(TaskRequestContext context, TaskOutput taskOutput)
Process the incoming request.
void saveViewFilterLimitHandler(RWDelta delta, JSONObject action, RWBean rwBean)
Protected Methods
void collectData(BeanTaskRequestContext btrContext)
This method calls the 'collectData' method on the WebBean instance.
String getStyleName(BeanTaskRequestContext btrContext)
void handleEvent(BeanTaskRequestContext btrContext)
This method instructs the WebBean to handle the event.
void overrideActualParameters(BeanTaskRequestContext btrContext, TransformInstance instance)
Overrides any actual parameters specified in the Bean Task XML.
void prepareBean(BeanTaskRequestContext btrContext)
This method prepares the WebBean for execution.
void prepareEventRequestKeys(RequestKeys requestKeys, EventInfo[] events)
void registerParameterMetadata(TaskParameterMetadata parameterMetadata)
Registers a specific Task parameter metadata.
void transformBean(BeanTaskRequestContext btrContext, TaskOutput taskOutput)
This method wraps a call to transform().
[Expand]
Inherited Methods
From class com.microstrategy.web.app.tasks.BeanTask
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.app.tasks.AbstractAppTask
From class com.microstrategy.web.tasks.AbstractBaseTask
From class java.lang.Object
From interface com.microstrategy.web.tasks.Task

Constants

protected static final String EVENT_ARG_SOURCE_PARAMETER

Constant Value: "parameter"

protected static final String EVENT_ARG_TRANSACTION_STRING

Constant Value: "transactionString"

protected static final String PARAM_DESC_CHANGES

Constant Value: "XML String containing the changes to apply to RWD before performing manipulation"

protected static final String PARAM_NAME_CHANGES

Constant Value: "updateChanges"

protected static final String PARAM_NAME_MESSAGE_ID

Constant Value: "messageID"

protected static final String PARAM_NAME_STATE_ID

Constant Value: "stateID"

Public Constructors

public MojoRWManipulationTask ()

Public Methods

public void processRequest (TaskRequestContext context, TaskOutput taskOutput)

Process the incoming request. This method proceeds through the following sequence:

  1. Check for all required parameters. (calls checkForRequiredParameters(RequestKeys))
  2. Prepare the RequestKeys for use. (calls prepareRequestKeys(BeanTaskRequestContext))
  3. Prepare the WebBean for use. (calls prepareBean(BeanTaskRequestContext))
  4. Handle the event. (calls handleEvent(BeanTaskRequestContext))
  5. Collect data for the request. (calls collectData(BeanTaskRequestContext))
  6. Serialize the results into the supplied TaskOutput. (calls serializeResult(BeanTaskRequestContext, TaskOutput))

Parameters
context The TaskRequestContext object that contains information specific to this request.
taskOutput The TaskOutput object to serialize the results into.
Throws
TaskException

public void saveViewFilterLimitHandler (RWDelta delta, JSONObject action, RWBean rwBean)

Throws
Exception

Protected Methods

protected void collectData (BeanTaskRequestContext btrContext)

This method calls the 'collectData' method on the WebBean instance. This method is called by processRequest(TaskRequestContext, TaskOutput).

Parameters
btrContext The BeanTaskRequestContext object.
Throws
TaskException

protected String getStyleName (BeanTaskRequestContext btrContext)

protected void handleEvent (BeanTaskRequestContext btrContext)

This method instructs the WebBean to handle the event. It is called from processRequest(TaskRequestContext, TaskOutput).

Parameters
btrContext The BeanTaskRequestContext that contains the WebBean instance.
Throws
TaskException

protected void overrideActualParameters (BeanTaskRequestContext btrContext, TransformInstance instance)

Overrides any actual parameters specified in the Bean Task XML. This method is called by the serializeResult(BeanTaskRequestContext, TaskOutput) method.

Parameters
btrContext The BeanTaskRequestContext to use.
instance The TransformInstance to operate on.

protected void prepareBean (BeanTaskRequestContext btrContext)

This method prepares the WebBean for execution. It is called by the processRequest(TaskRequestContext, TaskOutput) method. It performs the following actions:

  1. Creates a new WebBean instance and adds it to the context. (calls createWebBean(BeanTaskRequestContext))
  2. Sets any bean properties. (calls setBeanProperties(BeanTaskRequestContext))
  3. Restores any bean state. (calls restoreBeanState(BeanTaskRequestContext))

Parameters
btrContext The BeanTaskRequestContext to use.
Throws
TaskException

protected void prepareEventRequestKeys (RequestKeys requestKeys, EventInfo[] events)

protected void registerParameterMetadata (TaskParameterMetadata parameterMetadata)

Registers a specific Task parameter metadata. This method is called by registerTaskMetadata(TaskMetadata). It is helpful to override in a Task so that a specific TaskParameterMetadata may be saved for later use.

Parameters
parameterMetadata The TaskParameterMetadata object being saved.

protected void transformBean (BeanTaskRequestContext btrContext, TaskOutput taskOutput)

This method wraps a call to transform(). It is called by the serializeResult(BeanTaskRequestContext, TaskOutput) method and simply calls the 'transform' method.

Parameters
btrContext The BeanTaskRequestContext object.
taskOutput The TaskOutput instance to generate into.