Package com.microstrategy.web.app.tasks

Class MojoRWEventsTask

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

All Implemented Interfaces:

Task

public class MojoRWEventsTask
extends BeanTask

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	EVENT_ARG_SOURCE_PARAMETER
protected static java.lang.String	EVENT_ARG_TRANSACTION_STRING
protected static java.lang.String	PARAM_DESC_CHANGES
protected static java.lang.String	PARAM_NAME_CHANGES
protected static java.lang.String	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
MojoRWEventsTask()

Method Summary

Modifier and Type	Method	Description
protected void	collectData(BeanTaskRequestContext btrContext)	This method calls the 'collectData' method on the WebBean instance.
protected java.lang.String	getStyleName(BeanTaskRequestContext btrContext)
protected void	handleEvent(BeanTaskRequestContext btrContext)	This method instructs the WebBean to handle the event.
protected void	overrideActualParameters(BeanTaskRequestContext btrContext, TransformInstance instance)	Overrides any actual parameters specified in the Bean Task XML.
protected void	prepareBean(BeanTaskRequestContext btrContext)	This method prepares the WebBean for execution.
protected void	prepareEventRequestKeys(RequestKeys requestKeys, EventInfo[] events)
protected void	registerParameterMetadata(TaskParameterMetadata parameterMetadata)	Registers a specific Task parameter metadata.

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, init, isSuccessfullyInitialized, newRequestContext, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareEventOrderRequestKeys, prepareEventOrderRequestKeys, prepareEventRequestKeys, prepareParameterRequestKeys, prepareRequestKeys, processRequest, 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, 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_MESSAGE_ID

protected static final java.lang.String PARAM_NAME_MESSAGE_ID

See Also:

Constant Field Values

PARAM_NAME_CHANGES

protected static final java.lang.String PARAM_NAME_CHANGES

See Also:

Constant Field Values

PARAM_DESC_CHANGES

protected static final java.lang.String PARAM_DESC_CHANGES

See Also:

Constant Field Values

EVENT_ARG_TRANSACTION_STRING

protected static final java.lang.String EVENT_ARG_TRANSACTION_STRING

See Also:

Constant Field Values

EVENT_ARG_SOURCE_PARAMETER

protected static final java.lang.String EVENT_ARG_SOURCE_PARAMETER

See Also:

Constant Field Values

Constructor Detail

MojoRWEventsTask

public MojoRWEventsTask()

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 WebComponentTask

Parameters:

parameterMetadata - The TaskParameterMetadata object being saved.

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.

prepareEventRequestKeys

protected void prepareEventRequestKeys(RequestKeys requestKeys,
                                       EventInfo[] events)

Overrides:

prepareEventRequestKeys in class WebComponentTask

getStyleName

protected java.lang.String getStyleName(BeanTaskRequestContext btrContext)
                                 throws TaskRequestMalformedException

Overrides:

getStyleName in class WebComponentTask

Throws:

TaskRequestMalformedException

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 the WebComponentTask.serializeResult(BeanTaskRequestContext, TaskOutput) method.

Overrides:

overrideActualParameters in class WebComponentTask

Parameters:

btrContext - The BeanTaskRequestContext to use.

instance - The TransformInstance to operate on.

Throws:

TaskRequestMalformedException

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 from WebComponentTask.processRequest(TaskRequestContext, TaskOutput).

Overrides:

handleEvent in class WebComponentTask

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.