public class

RWManipulationTask

extends BeanTask
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.RWManipulationTask
Known Direct Subclasses

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
[Expand]
Inherited Constants
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.tasks.AbstractBaseTask
[Expand]
Inherited Fields
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.tasks.AbstractBaseTask
Public Constructors
RWManipulationTask()
Protected Methods
void collectData(BeanTaskRequestContext btrContext)
This method calls the 'collectData' method on the WebBean instance.
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.
[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"

Public Constructors

public RWManipulationTask ()

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 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.