Package com.microstrategy.web.app.tasks

Class MobileChunkedRWResultsTask

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

All Implemented Interfaces:

Task

public class MobileChunkedRWResultsTask
extends BeanTask

Since:

MicroStrategy Web 8.1.2

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	PARAM_NAME_COMPRESSION_VERSION

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

Method Summary

Modifier and Type	Method	Description
protected void	collectData(BeanTaskRequestContext bsrContext)	This method calls the 'collectData' method on the WebBean instance.
protected WebResultSetInstance	duplicateMessageAndWaitForResult(java.lang.String messageID, int stateID, WebObjectsFactory factory, RequestKeys rk)
protected WebResultSetInstance	getInitialInstance(java.lang.String messageID, int stateID, WebObjectsFactory factory)
protected WebResultSetInstance	getNewInstanceForDuplicatedMessage(java.lang.String messageID, int stateID, WebObjectsFactory factory, RequestKeys rk)
protected int	getParameter(RequestKeys keys, java.lang.String name, int defaultValue)
protected boolean	hasMobileState(RequestKeys rk)
TaskRequestContext	newRequestContext()	Returns a BeanTaskRequestContext object to use for the duration of this request.
protected void	prepareBean(BeanTaskRequestContext bsrContext)	This method prepares the WebBean for execution.
protected void	serializeResult(BeanTaskRequestContext btrContext, TaskOutput markupOutput)	This method attempts to serialize the results to the supplied TaskOutput object.
protected void	setBeanContext(BeanTaskRequestContext btrContext)	Set the BeanContext associated with the Bean.
protected void	transformBean(BeanTaskRequestContext btrContext, TaskOutput markupOutput)	This method wraps a call to Transformable.transform().

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, overrideActualParameters, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareEventOrderRequestKeys, prepareEventOrderRequestKeys, prepareEventRequestKeys, prepareEventRequestKeys, prepareParameterRequestKeys, prepareRequestKeys, processRequest, registerParameterMetadata, registerTaskMetadata, requiresIServerSession, restoreBeanState, setBeanInfo, setBeanName, setBeanProperties, setBeanSession, setSuccessfullyInitialized, setTaskID

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

Field Detail

PARAM_NAME_COMPRESSION_VERSION

protected static final java.lang.String PARAM_NAME_COMPRESSION_VERSION

See Also:

Constant Field Values

Constructor Detail

MobileChunkedRWResultsTask

public MobileChunkedRWResultsTask()

Method Detail

getInitialInstance

protected WebResultSetInstance getInitialInstance(java.lang.String messageID,
                                                  int stateID,
                                                  WebObjectsFactory factory)
                                           throws WebObjectsException

Throws:

WebObjectsException

getNewInstanceForDuplicatedMessage

protected WebResultSetInstance getNewInstanceForDuplicatedMessage(java.lang.String messageID,
                                                                  int stateID,
                                                                  WebObjectsFactory factory,
                                                                  RequestKeys rk)
                                                           throws WebObjectsException

Throws:

WebObjectsException

prepareBean

protected void prepareBean(BeanTaskRequestContext bsrContext)
                    throws TaskException

Description copied from class: WebComponentTask

This method prepares the WebBean for execution. It is called by the WebComponentTask.processRequest(TaskRequestContext, TaskOutput) method. It performs the following actions:

1. Creates a new WebBean instance and adds it to the context. (calls WebComponentTask.createWebBean(BeanTaskRequestContext))
2. Sets any bean properties. (calls WebComponentTask.setBeanProperties(BeanTaskRequestContext))
3. Restores any bean state. (calls WebComponentTask.restoreBeanState(BeanTaskRequestContext))

Overrides:

prepareBean in class WebComponentTask

Parameters:

bsrContext - The BeanTaskRequestContext to use.

Throws:

TaskException - If anything 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.

transformBean

protected void transformBean(BeanTaskRequestContext btrContext,
                             TaskOutput markupOutput)
                      throws TaskConfigurationException

Description copied from class: WebComponentTask

This method wraps a call to Transformable.transform(). It is called by the WebComponentTask.serializeResult(BeanTaskRequestContext, TaskOutput) method and simply calls the 'transform' method.

Overrides:

transformBean in class WebComponentTask

Parameters:

btrContext - The BeanTaskRequestContext object.

markupOutput - The TaskOutput instance to generate into.

Throws:

TaskConfigurationException - If the Transform does not exist.

Since:

MicroStrategy Web 9.0.0

setBeanContext

protected void setBeanContext(BeanTaskRequestContext btrContext)

Description copied from class: WebComponentTask

Set the BeanContext associated with the Bean. This method is called by the WebComponentTask.setBeanProperties(BeanTaskRequestContext) method.

Overrides:

setBeanContext in class WebComponentTask

Parameters:

btrContext - The BeanTaskRequestContext object to use.

newRequestContext

public TaskRequestContext newRequestContext()

Description copied from class: WebComponentTask

Returns a BeanTaskRequestContext object to use for the duration of this request.

Specified by:

newRequestContext in interface Task

Overrides:

newRequestContext in class WebComponentTask

Returns:

The BeanTaskRequestContext object to use for the duration of this request.

serializeResult

protected void serializeResult(BeanTaskRequestContext btrContext,
                               TaskOutput markupOutput)
                        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.

markupOutput - The TaskOutput object to populate.

Throws:

TaskException - If something fails along the way.

getParameter

protected int getParameter(RequestKeys keys,
                           java.lang.String name,
                           int defaultValue)

hasMobileState

protected boolean hasMobileState(RequestKeys rk)

duplicateMessageAndWaitForResult

protected WebResultSetInstance duplicateMessageAndWaitForResult(java.lang.String messageID,
                                                                int stateID,
                                                                WebObjectsFactory factory,
                                                                RequestKeys rk)
                                                         throws WebObjectsException,
                                                                TaskInternalException

Throws:

WebObjectsException

TaskInternalException