Package com.microstrategy.web.app.tasks

Class ModifyUserTask

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

All Implemented Interfaces:

Task

public class ModifyUserTask
extends BeanTask

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

Method Summary

Modifier and Type	Method	Description
protected void	prepareBean(BeanTaskRequestContext bsrContext)	This method prepares the WebBean for execution.
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, handleEvent, init, isSuccessfullyInitialized, newRequestContext, overrideActualParameters, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareEventOrderRequestKeys, prepareEventOrderRequestKeys, prepareEventRequestKeys, 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

Constructor Detail

ModifyUserTask

public ModifyUserTask()

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 bsrContext)
                    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:

bsrContext - The BeanTaskRequestContext to use.

Throws:

TaskException - If anything fails along the way.