Package com.microstrategy.web.app.tasks

Class SetRWUnitPropertiesTask

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

com.microstrategy.web.app.tasks.SetRWUnitPropertiesTask

All Implemented Interfaces:

Task

public class SetRWUnitPropertiesTask
extends RWManipulationTask

Field Summary

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

EVENT_ARG_SOURCE_PARAMETER, EVENT_ARG_TRANSACTION_STRING, PARAM_DESC_CHANGES, PARAM_NAME_CHANGES, PARAM_NAME_COMPRESS, 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
SetRWUnitPropertiesTask()

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)	This method prepares the RequestKeys by adding the necessary keys for events.
protected void	registerParameterMetadata(TaskParameterMetadata parameterMetadata)	Registers a specific Task parameter metadata.
protected void	transformBean(BeanTaskRequestContext btrContext, TaskOutput taskOutput)	This method wraps a call to Transformable.transform().

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

prepareBean, prepareEventRequestKeys

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SetRWUnitPropertiesTask

public SetRWUnitPropertiesTask()

Method Detail

registerParameterMetadata

protected void registerParameterMetadata(TaskParameterMetadata parameterMetadata)

Description copied from class: WebComponentTask

Registers a specific Task parameter metadata. This method is called by WebComponentTask.registerTaskMetadata(TaskMetadata). It is helpful to override in a Task so that a specific TaskParameterMetadata may be saved for later use.

Overrides:

registerParameterMetadata in class RWManipulationTask

Parameters:

parameterMetadata - The TaskParameterMetadata object being saved.

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 RWManipulationTask

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)

Description copied from class: WebComponentTask

This method prepares the RequestKeys by adding the necessary keys for events. If there is only one event, then the GenericWebEvent.URL_EVENT_NAME key is added. Otherwise, the WebComponentTask.prepareEventOrderRequestKeys(RequestKeys) method is called. Next, it calls the WebComponentTask.prepareArgumentRequestKeys(RequestKeys) method to add any keys defined for Event Arguments in the Bean Task XML.

Overrides:

prepareEventRequestKeys in class WebComponentTask

Parameters:

requestKeys - The RequestKeys object to add keys to.

transformBean

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

taskOutput - The TaskOutput instance to generate into.

Throws:

TaskConfigurationException - If the Transform does not exist.