Package com.microstrategy.web.app.tasks

Class ExportDocumentTask

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

com.microstrategy.web.app.tasks.ExportDocumentTask

All Implemented Interfaces:

Task

public class ExportDocumentTask
extends RWExecutionTask

Task for executing a Document that is capable of fetching binary contents.

Since:

MicroStrategy Web 9.2.1

Field Summary

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

executionModeParam, 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
ExportDocumentTask()

Method Summary

Modifier and Type	Method	Description
protected void	collectData(BeanTaskRequestContext btrContext)	This method calls the 'collectData' method on the WebBean instance.
void	processRequest(TaskRequestContext context, TaskOutput taskOutput)	Process the incoming request.
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	setBeanSession(BeanTaskRequestContext btrContext)	Set the WebIServerSession object to use with the WebBean.
protected boolean	shouldApplyGroupByChanges()

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

generatesContent, getExecutionModeFromRequest, handleEvent, minimalData, setExecutionMode, setGridResultFlags

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

createWebBean

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

addTransform, createUntypedWebComponent, destroy, getBeanInfo, getStyleName, init, isSuccessfullyInitialized, newRequestContext, overrideActualParameters, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareBean, prepareEventOrderRequestKeys, prepareEventOrderRequestKeys, prepareEventRequestKeys, prepareEventRequestKeys, prepareParameterRequestKeys, prepareRequestKeys, registerTaskMetadata, requiresIServerSession, restoreBeanState, setBeanContext, setBeanInfo, setBeanName, setBeanProperties, 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

ExportDocumentTask

public ExportDocumentTask()

Method Detail

processRequest

public void processRequest(TaskRequestContext context,
                           TaskOutput taskOutput)
                    throws TaskException

Description copied from class: WebComponentTask

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

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

Specified by:

processRequest in interface Task

Overrides:

processRequest in class WebComponentTask

Parameters:

context - The TaskRequestContext object that contains information specific to this request.

taskOutput - The TaskOutput object to serialize the results into.

Throws:

TaskException - If anything fails in the process of servicing the request.

TaskConfigurationException - If the task is not properly configured.

See Also:

Task.processRequest(TaskRequestContext, TaskOutput)

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 RWExecutionTask

Parameters:

parameterMetadata - The TaskParameterMetadata object being saved.

setBeanSession

protected void setBeanSession(BeanTaskRequestContext btrContext)
                       throws TaskException

Description copied from class: WebComponentTask

Set the WebIServerSession object to use with the WebBean. This method is called by the WebComponentTask.setBeanProperties(BeanTaskRequestContext) method.

Overrides:

setBeanSession in class WebComponentTask

Parameters:

btrContext - The BeanTaskRequestContext object to use.

Throws:

TaskException - If there is not enough information to create a WebIServerSession instance.

shouldApplyGroupByChanges

protected boolean shouldApplyGroupByChanges()

Overrides:

shouldApplyGroupByChanges in class RWExecutionTask

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 RWExecutionTask

Parameters:

btrContext - The BeanTaskRequestContext object.

Throws:

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

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 RWExecutionTask

Parameters:

btrContext - The BeanTaskRequestContext object.

taskOutput - The TaskOutput object to populate.

Throws:

TaskException - If something fails along the way.