Package com.microstrategy.web.app.tasks
Class MobileRWResultsTask
- 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.MobileRWResultsTask
-
-
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 MobileRWResultsTask()
-
Method Summary
All Methods Instance Methods Concrete Methods 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 boolean
hasMobileState(RequestKeys rk)
protected void
makeTabular(WebTemplate t)
protected boolean
makeTabular(WebTemplate t, boolean removeSubtotals)
protected void
moveUnit(WebTemplate template, com.microstrategy.web.app.tasks.MobileUnit unit)
TaskRequestContext
newRequestContext()
Returns a BeanTaskRequestContext object to use for the duration of this request.protected void
overrideActualParameters(BeanTaskRequestContext btrContext, TransformInstance instance)
Overrides any actual parameters specified in the Bean Task XML.protected void
prepareBean(BeanTaskRequestContext bsrContext)
This method prepares the WebBean for execution.protected void
restoreMobileState(WebTemplate template, com.microstrategy.web.app.tasks.MobileTemplate mbTemplate, boolean includePageByManipulation)
protected void
setCurrentElement(WebTemplate template, com.microstrategy.web.app.tasks.MobileUnit unit)
protected void
transformBean(BeanTaskRequestContext btrContext, TaskOutput taskOutput)
This method wraps a call toTransformable.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, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareEventOrderRequestKeys, prepareEventOrderRequestKeys, prepareEventRequestKeys, prepareEventRequestKeys, prepareParameterRequestKeys, prepareRequestKeys, processRequest, registerParameterMetadata, registerTaskMetadata, requiresIServerSession, restoreBeanState, serializeResult, setBeanContext, 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
-
-
-
-
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 theWebComponentTask.processRequest(TaskRequestContext, TaskOutput)
method. It performs the following actions:- Creates a new WebBean instance and adds it to the
context. (calls
WebComponentTask.createWebBean(BeanTaskRequestContext)
) - Sets any bean properties. (calls
WebComponentTask.setBeanProperties(BeanTaskRequestContext)
) - Restores any bean state. (calls
WebComponentTask.restoreBeanState(BeanTaskRequestContext)
)
- Overrides:
prepareBean
in classWebComponentTask
- Parameters:
bsrContext
- The BeanTaskRequestContext to use.- Throws:
TaskException
- If anything fails along the way.
- Creates a new WebBean instance and adds it to the
context. (calls
-
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 byWebComponentTask.processRequest(TaskRequestContext, TaskOutput)
.- Overrides:
collectData
in classWebComponentTask
- 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 taskOutput) throws TaskConfigurationException
Description copied from class:WebComponentTask
This method wraps a call toTransformable.transform()
. It is called by theWebComponentTask.serializeResult(BeanTaskRequestContext, TaskOutput)
method and simply calls the 'transform' method.- Overrides:
transformBean
in classWebComponentTask
- Parameters:
btrContext
- The BeanTaskRequestContext object.taskOutput
- The TaskOutput instance to generate into.- Throws:
TaskConfigurationException
- If the Transform does not exist.- Since:
- MicroStrategy Web 9.0.0
-
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 interfaceTask
- Overrides:
newRequestContext
in classWebComponentTask
- Returns:
- The
BeanTaskRequestContext
object to use for the duration of this request.
-
overrideActualParameters
protected void overrideActualParameters(BeanTaskRequestContext btrContext, TransformInstance instance) throws TaskRequestMalformedException
Description copied from class:WebComponentTask
Overrides any actual parameters specified in the Bean Task XML. This method is called by theWebComponentTask.serializeResult(BeanTaskRequestContext, TaskOutput)
method.- Overrides:
overrideActualParameters
in classWebComponentTask
- Parameters:
btrContext
- The BeanTaskRequestContext to use.instance
- The TransformInstance to operate on.- Throws:
TaskRequestMalformedException
- Since:
- MicroStrategy Web 8.1.2
-
hasMobileState
protected boolean hasMobileState(RequestKeys rk)
-
makeTabular
protected void makeTabular(WebTemplate t)
-
makeTabular
protected boolean makeTabular(WebTemplate t, boolean removeSubtotals)
-
setCurrentElement
protected void setCurrentElement(WebTemplate template, com.microstrategy.web.app.tasks.MobileUnit unit)
-
moveUnit
protected void moveUnit(WebTemplate template, com.microstrategy.web.app.tasks.MobileUnit unit)
-
restoreMobileState
protected void restoreMobileState(WebTemplate template, com.microstrategy.web.app.tasks.MobileTemplate mbTemplate, boolean includePageByManipulation)
-
duplicateMessageAndWaitForResult
protected WebResultSetInstance duplicateMessageAndWaitForResult(java.lang.String messageID, int stateID, WebObjectsFactory factory, RequestKeys rk) throws WebObjectsException, TaskInternalException
-
-