Package com.microstrategy.web.app.tasks

Class GetRWGridFormatTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.app.tasks.AbstractAppTask

com.microstrategy.web.app.tasks.GetRWGridFormatTask

All Implemented Interfaces:

Task

public class GetRWGridFormatTask
extends AbstractAppTask

This task provides the ability to get formatting information about a specific grid in a document

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	PARAM_NAME_GRID_KEY	Grid Key

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
GetRWGridFormatTask()

Method Summary

Modifier and Type	Method	Description
void	processRequest(TaskRequestContext btrContext, TaskOutput taskOutput)	The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes the AbstractBaseTask.processRequest(TaskRequestContext, MarkupOutput) version.

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

getDescriptor, newRequestContext

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, destroy, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, init, 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

Field Detail

PARAM_NAME_GRID_KEY

protected static final java.lang.String PARAM_NAME_GRID_KEY

Grid Key

See Also:

Constant Field Values

Constructor Detail

GetRWGridFormatTask

public GetRWGridFormatTask()

Method Detail

processRequest

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

Description copied from class: AbstractBaseTask

The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes the AbstractBaseTask.processRequest(TaskRequestContext, MarkupOutput) version.

Specified by:

processRequest in interface Task

Overrides:

processRequest in class AbstractBaseTask

Parameters:

btrContext - The TaskRequestContext object that maintains the state of the request.

taskOutput - The TaskOutput that contains the output generated by the Task.

Throws:

TaskException - If the Task was unable to satisfy the request.

See Also:

Task.processRequest(TaskRequestContext, TaskOutput)