Package com.microstrategy.web.app.tasks

Class ElementsBrowseTask

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

All Implemented Interfaces:

Task

public class ElementsBrowseTask
extends BeanTask

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TASK_PARAM_NAME_ATTRIBUTE	The name of the Task parameter that identifies whether this Task is invoked for the Javascript UI Library ("JUIL").
static java.lang.String	TASK_PARAM_NAME_MATCH	The name of the Task parameter that identifies whether this Task is invoked for the Javascript UI Library ("JUIL").
static java.lang.String	TASK_PARAM_NAME_PATTERN	The name of the Task parameter that identifies whether this Task is invoked for the Javascript UI Library ("JUIL").
static java.lang.String	TASK_PARAM_NAME_TARGET	The name of the Task parameter that identifies whether this Task is invoked for the Javascript UI Library ("JUIL").

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

Method Summary

Modifier and Type	Method	Description
protected void	handleEvent(BeanTaskRequestContext btrContext)	This method instructs the WebBean to handle the event.
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, collectData, createUntypedWebComponent, destroy, generatesContent, getBeanInfo, getStyleName, init, isSuccessfullyInitialized, newRequestContext, overrideActualParameters, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareBean, 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

TASK_PARAM_NAME_TARGET

public static final java.lang.String TASK_PARAM_NAME_TARGET

The name of the Task parameter that identifies whether this Task is invoked for the Javascript UI Library ("JUIL").

See Also:

Constant Field Values

TASK_PARAM_NAME_ATTRIBUTE

public static final java.lang.String TASK_PARAM_NAME_ATTRIBUTE

The name of the Task parameter that identifies whether this Task is invoked for the Javascript UI Library ("JUIL").

See Also:

Constant Field Values

TASK_PARAM_NAME_PATTERN

public static final java.lang.String TASK_PARAM_NAME_PATTERN

The name of the Task parameter that identifies whether this Task is invoked for the Javascript UI Library ("JUIL").

See Also:

Constant Field Values

TASK_PARAM_NAME_MATCH

public static final java.lang.String TASK_PARAM_NAME_MATCH

The name of the Task parameter that identifies whether this Task is invoked for the Javascript UI Library ("JUIL").

See Also:

Constant Field Values

Constructor Detail

ElementsBrowseTask

public ElementsBrowseTask()

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.

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.

prepareEventRequestKeys

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

Overrides:

prepareEventRequestKeys in class WebComponentTask