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

All Implemented Interfaces:

Task

Direct Known Subclasses:

AndroidRWExecutionTask, ExportDocumentTask, GetServerJSONResultsTask, RWBinaryExecutionTask
```
public class RWExecutionTask
extends BeanTask
```
This class implements a Report Writer Document Execution Task.

Since:

MicroStrategy Web 8.1.0

Field Summary

Fields
Modifier and Type Field Description

protected TaskParameterMetadata executionModeParam

protected static java.lang.String PARAM_NAME_MESSAGE_ID
- Fields inherited from class com.microstrategy.web.app.tasks.WebComponentTask
  FP_NAME_CONTENT_TYPE, initializationErrorMessage
- Fields inherited from class com.microstrategy.web.tasks.AbstractBaseTask
  compressOutput, CONTENT_TYPE_BINARY, CONTENT_TYPE_HTML, CONTENT_TYPE_JSON, CONTENT_TYPE_JSON_ALL, CONTENT_TYPE_JSON_D, CONTENT_TYPE_JSON_P, CONTENT_TYPE_XML, CONTENT_TYPE_XML_ANF, DEFAULT_MAX_WAIT, DEFAULT_POLLING_FREQ, execFlagsParam, INDEFINITE_MAX_WAIT, maxWaitParam, metadata, mPrivileges, msgIDParam, objectIDParam, OTHER_CONTENT_KEY_LAYOUTS, PARAM_NAME_EXEC_FLAGS, PARAM_NAME_MAX_WAIT, PARAM_NAME_OBJECT_ID, PARAM_NAME_POLLING_FREQ, PARAM_NAME_RESULT_FLAGS, PARAM_NAME_SESSION_ID, PARAM_NAME_SESSION_STATE, PARAM_NAME_STATE_ID, pollingFreqParam, PREFERENCE_DEFAULT_MAX_WAIT_IN_TASK, resultFlagsParam, sessionIDParam, sessionStateParam, stateIDParam

Constructor Summary

Constructors
Constructor Description

RWExecutionTask()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`collectData(BeanTaskRequestContext btrContext)`	This method calls the 'collectData' method on the WebBean instance.
`protected boolean`	`generatesContent(BeanTaskRequestContext btrContext)`	Override the implementation of the super class to decide whether to collectData or collectMinimalData.
`protected int`	`getExecutionModeFromRequest(BeanTaskRequestContext btrContext)`
`protected void`	`handleEvent(BeanTaskRequestContext btrContext)`	This method instructs the WebBean to handle the event.
`protected boolean`	`minimalData(BeanTaskRequestContext btrContext)`
`protected void`	`registerParameterMetadata(TaskParameterMetadata parameterMetadata)`	Registers a specific Task parameter metadata.
`protected void`	`serializeResult(BeanTaskRequestContext btrContext, TaskOutput taskOutput)`	This method attempts to serialize the results to the supplied TaskOutput object.
`protected void`	`setExecutionMode(BeanTaskRequestContext btrContext)`
`protected void`	`setGridResultFlags(BeanTaskRequestContext btrContext)`
`protected boolean`	`shouldApplyGroupByChanges()`

Methods inherited from class com.microstrategy.web.app.tasks.BeanTask
createWebBean

Methods inherited from class com.microstrategy.web.app.tasks.AbstractAppTask
getDescriptor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PARAM_NAME_MESSAGE_ID
```
protected static final java.lang.String PARAM_NAME_MESSAGE_ID
```
    See Also:
    
    Constant Field Values
  - executionModeParam
```
protected TaskParameterMetadata executionModeParam
```
- Constructor Detail
  - RWExecutionTask
```
public RWExecutionTask()
```
- Method Detail
  - registerParameterMetadata
```
protected void registerParameterMetadata(TaskParameterMetadata parameterMetadata)
```
    Description copied from class: WebComponentTask
    
    Registers a specific Task parameter metadata. This method is called by WebComponentTask.registerTaskMetadata(TaskMetadata). It is helpful to override in a Task so that a specific TaskParameterMetadata may be saved for later use.
    
    Overrides:
    
    registerParameterMetadata in class WebComponentTask
    
    Parameters:
    
    parameterMetadata - The TaskParameterMetadata object being saved.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - handleEvent
```
protected void handleEvent(BeanTaskRequestContext btrContext)
                    throws TaskException
```
    Description copied from class: WebComponentTask
    
    This method instructs the WebBean to handle the event. It is called from WebComponentTask.processRequest(TaskRequestContext, TaskOutput).
    
    Overrides:
    
    handleEvent in class WebComponentTask
    
    Parameters:
    
    btrContext - The BeanTaskRequestContext that contains the WebBean instance.
    
    Throws:
    
    TaskException - If something fails in the process of handling the event.
    
    TaskRequestMalformedException - If there was an exception raised while handling the event.
  - serializeResult
```
protected void serializeResult(BeanTaskRequestContext btrContext,
                               TaskOutput taskOutput)
                        throws TaskException
```
    Description copied from class: WebComponentTask
    This method attempts to serialize the results to the supplied TaskOutput object. This method is called by WebComponentTask.processRequest(TaskRequestContext, TaskOutput) and in turn does the following:
    
    Add the Transform. If there is no transform specified, an empty MarkupOutput is returned. (calls WebComponentTask.addTransform(BeanTaskRequestContext))
    
    Override any actual parameters specified in the Bean Task XML. (calls WebComponentTask.overrideActualParameters(BeanTaskRequestContext, TransformInstance))
    
    Transforms the WebBean using the Transform. (calls WebComponentTask.transformBean(BeanTaskRequestContext, TaskOutput))
    Overrides:
    
    serializeResult in class WebComponentTask
    
    Parameters:
    
    btrContext - The BeanTaskRequestContext object.
    
    taskOutput - The TaskOutput object to populate.
    
    Throws:
    
    TaskException - If something fails along the way.
  - generatesContent
```
protected boolean generatesContent(BeanTaskRequestContext btrContext)
                            throws TaskException
```
    Override the implementation of the super class to decide whether to collectData or collectMinimalData. If the client is a dossier client, we know that we need to call the collectData to get the statusID
    
    Overrides:
    
    generatesContent in class WebComponentTask
    
    Parameters:
    
    btrContext - The BeanTaskRequestContext object.
    
    Returns:
    
    Throws:
    
    TaskException
  - collectData
```
protected void collectData(BeanTaskRequestContext btrContext)
                    throws TaskException
```
    Description copied from class: WebComponentTask
    
    This method calls the 'collectData' method on the WebBean instance. This method is called by WebComponentTask.processRequest(TaskRequestContext, TaskOutput).
    
    Overrides:
    
    collectData in class WebComponentTask
    
    Parameters:
    
    btrContext - The BeanTaskRequestContext object.
    
    Throws:
    
    TaskException - If there is a failure while trying to collect data for the Web Bean.
  - minimalData
```
protected boolean minimalData(BeanTaskRequestContext btrContext)
                       throws TaskException
```
    Throws:
    
    TaskException
  - shouldApplyGroupByChanges
```
protected boolean shouldApplyGroupByChanges()
```
  - setExecutionMode
```
protected void setExecutionMode(BeanTaskRequestContext btrContext)
                         throws TaskInternalException,
                                TaskRequestMalformedException
```
    Throws:
    
    TaskInternalException
    
    TaskRequestMalformedException
  - getExecutionModeFromRequest
```
protected int getExecutionModeFromRequest(BeanTaskRequestContext btrContext)
                                   throws TaskInternalException,
                                          TaskRequestMalformedException
```
    Throws:
    
    TaskInternalException
    
    TaskRequestMalformedException
  - setGridResultFlags
```
protected void setGridResultFlags(BeanTaskRequestContext btrContext)
                           throws TaskInternalException,
                                  TaskRequestMalformedException
```
    Throws:
    
    TaskInternalException
    
    TaskRequestMalformedException

Class RWExecutionTask

Field Summary

Fields inherited from class com.microstrategy.web.app.tasks.WebComponentTask

Fields inherited from class com.microstrategy.web.tasks.AbstractBaseTask

Constructor Summary

Method Summary

Methods inherited from class com.microstrategy.web.app.tasks.BeanTask

Methods inherited from class com.microstrategy.web.app.tasks.WebComponentTask

Methods inherited from class com.microstrategy.web.app.tasks.AbstractAppTask

Methods inherited from class com.microstrategy.web.tasks.AbstractBaseTask

Methods inherited from class java.lang.Object

Field Detail

PARAM_NAME_MESSAGE_ID

executionModeParam

Constructor Detail

RWExecutionTask

Method Detail

registerParameterMetadata

handleEvent

serializeResult

generatesContent

collectData

minimalData

shouldApplyGroupByChanges

setExecutionMode

getExecutionModeFromRequest

setGridResultFlags

Modifier and Type	Field	Description
`protected TaskParameterMetadata`	`executionModeParam`
`protected static java.lang.String`	`PARAM_NAME_MESSAGE_ID`