Package com.microstrategy.web.app.tasks

Class GetDescriptorsTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.app.tasks.AbstractAppTask

com.microstrategy.web.app.tasks.GetDescriptorsTask

All Implemented Interfaces:

Task

public class GetDescriptorsTask
extends AbstractAppTask

This is the task for retrieving descriptors for certain locale. The locale is specified from task parameter or from the session information.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PARAM_NAME_KEYS
static java.lang.String	PARAM_NAME_LOCALEID
static java.lang.String	PARAM_NAME_PREFIX

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
GetDescriptorsTask()
GetDescriptorsTask(java.lang.String desc)

Method Summary

Modifier and Type	Method	Description
void	processRequest(TaskRequestContext context, MarkupOutput markupOutput)	The default implementation of this version of processRequest is empty.

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

getDescriptor, newRequestContext

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, destroy, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, init, 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_KEYS

public static final java.lang.String PARAM_NAME_KEYS

See Also:

Constant Field Values

PARAM_NAME_PREFIX

public static final java.lang.String PARAM_NAME_PREFIX

See Also:

Constant Field Values

PARAM_NAME_LOCALEID

public static final java.lang.String PARAM_NAME_LOCALEID

See Also:

Constant Field Values

Constructor Detail

GetDescriptorsTask

public GetDescriptorsTask(java.lang.String desc)

GetDescriptorsTask

public GetDescriptorsTask()

Method Detail

processRequest

public void processRequest(TaskRequestContext context,
                           MarkupOutput markupOutput)
                    throws TaskException

Description copied from class: AbstractBaseTask

The default implementation of this version of processRequest is empty. Task implementators may override either version of processRequest.

Specified by:

processRequest in interface Task

Overrides:

processRequest in class AbstractBaseTask

Parameters:

context - The TaskRequestContext object that maintains the state of the request.

markupOutput - The MarkupOutput that records the contents of the Task response.

Throws:

TaskException - If the Task was unable to satisfy the request.

See Also:

Task.processRequest(TaskRequestContext, MarkupOutput)