Package com.microstrategy.web.app.tasks

Class BeanTask

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

All Implemented Interfaces:

Task

Direct Known Subclasses:

AbstractDataServiceTask, AbstractMobileSubscriptionTask, AbstractSaveTask, BaseFolderTask, BaseUserEntityBeanTask, BeanManipulationTask, CreateGroupTask, CreateUserTask, ElementsBrowseTask, FolderBrowseTask, GetDossierTOCAndPromptsTask, GetRWGraphImageTask, GridLinkedDrillTask, IPhoneReportResultsTask, IPhoneRWResultsTask, MetadataSearchTask, MobileChunkedGraphResultsTask, MobileChunkedGridResultsTask, MobileChunkedRWResultsTask, MobileDeleteSubscriptionTask, MobileGraphXMLTask, MobileGridResultsTask, MobileHTMLGridResultsTask, MobileRWResultsTask, ModifyChildrenTask, ModifyUserTask, MojoRWEventsTask, MojoRWManipulationTask, ReportExecutionTask, RetrieveChildrenTask, RWExecutionTask, RWLinkedDrillTask, RWManipulationTask, RWOnDemandDrillTask, SaveSubscriptionTask, WriteOnlyBeanTask

public class BeanTask
extends WebComponentTask

This class implements the Task interface using a WebBean to handle data collection. It extends WebComponentTask which provides the bulk of the implementation. The definition of the task is provided through a single XML file.

Since:

MicroStrategy Web 8.1.0

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
BeanTask()	Creates a new BeanTask object.

Method Summary

Modifier and Type	Method	Description
protected WebBean	createWebBean(BeanTaskRequestContext btrContext)	Creates a new instance of a WebBean.

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

addTransform, collectData, createUntypedWebComponent, destroy, generatesContent, getBeanInfo, getStyleName, handleEvent, init, isSuccessfullyInitialized, newRequestContext, overrideActualParameters, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareBean, prepareEventOrderRequestKeys, prepareEventOrderRequestKeys, prepareEventRequestKeys, prepareEventRequestKeys, prepareParameterRequestKeys, prepareRequestKeys, processRequest, registerParameterMetadata, 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

Constructor Detail

BeanTask

public BeanTask()

Creates a new BeanTask object. All BeanTasks have an implicit "session state" parameter (see AbstractBaseTask.addSessionStateParam(boolean, String)).

Method Detail

createWebBean

protected WebBean createWebBean(BeanTaskRequestContext btrContext)
                         throws TaskConfigurationException

Creates a new instance of a WebBean. This method is called by the WebComponentTask.prepareBean(BeanTaskRequestContext) method.

Overrides:

createWebBean in class WebComponentTask

Parameters:

btrContext - The BeanTaskRequestContext object to use.

Returns:

A WebBean instance.

Throws:

TaskConfigurationException - If the WebBean cannot be created using the information supplied.

See Also:

WebComponentTask.createUntypedWebComponent(BeanTaskRequestContext)