Package com.microstrategy.web.app.tasks
Class ResultSetBeanManipulationTask
- 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.BeanManipulationTask
-
- com.microstrategy.web.app.tasks.ResultSetBeanManipulationTask
-
- All Implemented Interfaces:
Task
public class ResultSetBeanManipulationTask extends BeanManipulationTask
-
-
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 ResultSetBeanManipulationTask()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
handleEvent(BeanTaskRequestContext btrContext)
This method instructs the WebBean to handle the event.protected void
prepareBean(BeanTaskRequestContext btrContext)
This method prepares the WebBean for execution.protected void
serializeResult(BeanTaskRequestContext btrContext, TaskOutput taskOutput)
This method attempts to serialize the results to the supplied TaskOutput object.-
Methods inherited from class com.microstrategy.web.app.tasks.BeanManipulationTask
collectData
-
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, init, isSuccessfullyInitialized, newRequestContext, overrideActualParameters, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareEventOrderRequestKeys, prepareEventOrderRequestKeys, prepareEventRequestKeys, prepareEventRequestKeys, prepareParameterRequestKeys, prepareRequestKeys, processRequest, registerParameterMetadata, 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
-
-
-
-
Method Detail
-
prepareBean
protected void prepareBean(BeanTaskRequestContext btrContext) 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:
btrContext
- The BeanTaskRequestContext to use.- Throws:
TaskException
- If anything fails along the way.
- Creates a new WebBean instance and adds it to the
context. (calls
-
handleEvent
protected void handleEvent(BeanTaskRequestContext btrContext) throws TaskException
Description copied from class:WebComponentTask
This method instructs the WebBean to handle the event. It is called fromWebComponentTask.processRequest(TaskRequestContext, TaskOutput)
.- Overrides:
handleEvent
in classWebComponentTask
- Parameters:
btrContext
- The BeanTaskRequestContext that contains the WebBean instance.- Throws:
TaskException
- If something fails in the process of handling the event.TaskRequestMalformedException
- If there was an exception raised while handling the event.
-
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 byWebComponentTask.processRequest(TaskRequestContext, TaskOutput)
and in turn does the following:- Add the Transform. If there is no transform
specified, an empty MarkupOutput is returned. (calls
WebComponentTask.addTransform(BeanTaskRequestContext)
) - Override any actual parameters specified in the
Bean Task XML. (calls
WebComponentTask.overrideActualParameters(BeanTaskRequestContext, TransformInstance)
) - Transforms the WebBean using the Transform. (calls
WebComponentTask.transformBean(BeanTaskRequestContext, TaskOutput)
)
- Overrides:
serializeResult
in classWebComponentTask
- Parameters:
btrContext
- The BeanTaskRequestContext object.taskOutput
- The TaskOutput object to populate.- Throws:
TaskException
- If something fails along the way.
- Add the Transform. If there is no transform
specified, an empty MarkupOutput is returned. (calls
-
-