Package com.microstrategy.web.app.tasks

Class GetServerJSONResultsTask

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

All Implemented Interfaces:

Task

public class GetServerJSONResultsTask
extends RWExecutionTask

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

Method Summary

Modifier and Type	Method	Description
protected void	collectData(BeanTaskRequestContext btrContext)	This method calls the 'collectData' method on the WebBean instance.
protected void	prepareEventRequestKeys(RequestKeys requestKeys, EventInfo[] events)
void	processRequest(TaskRequestContext context, TaskOutput taskOutput)	Process the incoming request.

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

generatesContent, getExecutionModeFromRequest, handleEvent, minimalData, registerParameterMetadata, serializeResult, setExecutionMode, setGridResultFlags, shouldApplyGroupByChanges

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, prepareParameterRequestKeys, prepareRequestKeys, 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

GetServerJSONResultsTask

public GetServerJSONResultsTask()

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)

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.

prepareEventRequestKeys

protected void prepareEventRequestKeys(RequestKeys requestKeys,
                                       EventInfo[] events)

Overrides:

prepareEventRequestKeys in class WebComponentTask