Package com.microstrategy.web.app.tasks

Class ReportExecutionTask

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

All Implemented Interfaces:

Task

Direct Known Subclasses:

ExportReportTask

public class ReportExecutionTask
extends BeanTask

Task for executing a report.
This task supports incremental fetch through its parameters.

Since:

MicroStrategy Web 9.0.0

Field Summary

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_MESSAGE_ID, 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
ReportExecutionTask()

Method Summary

Modifier and Type	Method	Description
protected void	collectData(BeanTaskRequestContext bsrContext)	This method calls the 'collectData' method on the WebBean instance.
protected void	registerParameterMetadata(TaskParameterMetadata parameterMetadata)	Registers a specific Task parameter metadata.
static void	serializeMessageResult(BeanTaskRequestContext btrContext, TaskOutput taskOutput, WebResultSetInstance wrsi)
protected void	serializeResult(BeanTaskRequestContext btrContext, TaskOutput taskOutput)	This method attempts to serialize the results to the supplied TaskOutput object.

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

createWebBean

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

addTransform, createUntypedWebComponent, destroy, generatesContent, getBeanInfo, getStyleName, handleEvent, init, isSuccessfullyInitialized, newRequestContext, overrideActualParameters, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareBean, prepareEventOrderRequestKeys, prepareEventOrderRequestKeys, prepareEventRequestKeys, prepareEventRequestKeys, prepareParameterRequestKeys, prepareRequestKeys, processRequest, registerTaskMetadata, requiresIServerSession, restoreBeanState, setBeanContext, setBeanInfo, setBeanName, setBeanProperties, setBeanSession, setSuccessfullyInitialized, setTaskID, transformBean

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

getDescriptor

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

addExecFlagsParam, addJuilLayouts, addMaxWaitParam, addMaxWaitParam, addMessageIDParam, addObjectIDParam, addParameterMetadata, addParameterMetadata, addParameterMetadata, addPollingFrequencyParam, addPollingFrequencyParam, addResultFlagsParam, addSessionIDParam, addSessionStateParam, addStateIDParam, checkForRequiredParameters, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, processRequest, retrieveUploadedFile, setCompressOutput, setDescription, setID, setMetadata, setPrivileges, validateContentType

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportExecutionTask

public ReportExecutionTask()

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.

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:

1. Add the Transform. If there is no transform specified, an empty MarkupOutput is returned. (calls WebComponentTask.addTransform(BeanTaskRequestContext))
2. Override any actual parameters specified in the Bean Task XML. (calls WebComponentTask.overrideActualParameters(BeanTaskRequestContext, TransformInstance))
3. 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.

collectData

protected void collectData(BeanTaskRequestContext bsrContext)
                    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:

bsrContext - The BeanTaskRequestContext object.

Throws:

TaskException - If there is a failure while trying to collect data for the Web Bean.

serializeMessageResult

public static void serializeMessageResult(BeanTaskRequestContext btrContext,
                                          TaskOutput taskOutput,
                                          WebResultSetInstance wrsi)
                                   throws TaskException

Throws:

TaskException