Package com.microstrategy.web.app.tasks

Class RWSaveTask

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

com.microstrategy.web.app.tasks.RWSaveTask

All Implemented Interfaces:

Task

public class RWSaveTask
extends AbstractSaveTask

This task saves a report services document to metadata

Since:

MicroStrategy Web 8.1.2

Field Summary

Fields inherited from class com.microstrategy.web.app.tasks.AbstractSaveTask

descParam, flagsParam, folderIDParam, nameParam, PARAM_NAME_FOLDER_ID, PARAM_NAME_REPORT_DESC, PARAM_NAME_REPORT_NAME, PARAM_NAME_SAVEAS_FLAGS, PARAM_NAME_SAVEAS_SKIPREBUILD, skipRebuildParam

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

Method Summary

Modifier and Type	Method	Description
protected void	collectData(BeanTaskRequestContext btrContext)	This method calls the 'collectData' method on the WebBean instance.
protected void	prepareBean(BeanTaskRequestContext btrContext)	This method prepares the WebBean for execution.
void	processRequest(TaskRequestContext context, TaskOutput taskOutput)	Process the incoming request.

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

getWebFolder, getWebObjectsFactory, processRequest, registerParameterMetadata

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, newRequestContext, overrideActualParameters, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareEventOrderRequestKeys, prepareEventOrderRequestKeys, prepareEventRequestKeys, prepareEventRequestKeys, prepareParameterRequestKeys, prepareRequestKeys, registerTaskMetadata, requiresIServerSession, restoreBeanState, serializeResult, 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, 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

RWSaveTask

public RWSaveTask()

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.

Since:

MicroStrategy Web 9.0.0

See Also:

Task.processRequest(TaskRequestContext, TaskOutput)

prepareBean

protected void prepareBean(BeanTaskRequestContext btrContext)
                    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:

btrContext - The BeanTaskRequestContext to use.

Throws:

TaskException - If anything fails along the way.

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 WebComponentTask

Parameters:

btrContext - The BeanTaskRequestContext object.

Throws:

TaskException - If there is a failure while trying to collect data for the Web Bean.