Package com.microstrategy.web.app.tasks

Class GetMetricDefinitionTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.app.tasks.AbstractAppTask

com.microstrategy.web.app.tasks.AbstractParseMetricTask

com.microstrategy.web.app.tasks.GetMetricDefinitionTask

All Implemented Interfaces:

Task

public class GetMetricDefinitionTask
extends AbstractParseMetricTask

Since:

MicroStrategy Web 9.2.2

Field Summary

Fields inherited from class com.microstrategy.web.app.tasks.AbstractParseMetricTask

BLK_DATA_TYPE, BLK_FOLDER, BLK_METRIC, BLK_METRIC_PROPERTIES, BLK_METRIC_SUBTOTAL, BLK_METRIC_SUBTOTALS, BLK_TOKEN, BLK_TOKEN_STREAM, BLK_WEBOBJECT_PROPERTY, BLK_WEBOBJECTINFO, BLP_DATA_TYPE_PRECISION, BLP_DATA_TYPE_SCALE, BLP_DATA_TYPE_TYPE, BLP_FOLDER_ITEMS, BLP_METRIC_DATA_TYPE, BLP_METRIC_FOMRAT, BLP_METRIC_GRID_FORMAT, BLP_METRIC_HEADER_FORMAT, BLP_METRIC_PROPERTIES, BLP_METRIC_PROPERTIES_AGGREGATE_FROM_BASE, BLP_METRIC_PROPERTIES_AGGREGATE_FROM_BASE_STYLE, BLP_METRIC_PROPERTIES_ALL_CHILDREN_JOIN, BLP_METRIC_PROPERTIES_CAN_BE_SMART, BLP_METRIC_PROPERTIES_FROM_BASE_FLAG, BLP_METRIC_PROPERTIES_METRIC_TYPE, BLP_METRIC_PROPERTIES_SMART_TOTAL, BLP_METRIC_SUBTOTAL_DEFINITION_METRIC, BLP_METRIC_SUBTOTALS, BLP_METRIC_SUBTOTALS_AGGREGATION, BLP_METRIC_SUBTOTALS_AVAILABLE, BLP_METRIC_SUBTOTALS_TOTAL, BLP_METRIC_TOKEN_STREAM, BLP_TOKEN_EXTRA_VALUE, BLP_TOKEN_EXTRA_VALUE_TYPE, BLP_TOKEN_LEVEL, BLP_TOKEN_OBJECT, BLP_TOKEN_SECTION_TYPE, BLP_TOKEN_STATE, BLP_TOKEN_STREAM_ITEMS, BLP_TOKEN_STREAM_METRIC_EDIT_TYPE, BLP_TOKEN_STREAM_REJECT_ERROR_CODE, BLP_TOKEN_STREAM_REJECT_ERROR_DESCRIPTION, BLP_TOKEN_STREAM_SEARCH_RESULTS_FOLDER, BLP_TOKEN_TYPE, BLP_TOKEN_VALUE, BLP_WEBOBJECT_PROPERTY_DATATYPE, BLP_WEBOBJECT_PROPERTY_DEFAULT_VALUE, BLP_WEBOBJECT_PROPERTY_ID, BLP_WEBOBJECT_PROPERTY_NAME, BLP_WEBOBJECT_PROPERTY_USE_DEFAULT, BLP_WEBOBJECT_PROPERTY_VALUE, BLP_WEBOBJECTINFO_DESC, BLP_WEBOBJECTINFO_DSSID, BLP_WEBOBJECTINFO_NAME, BLP_WEBOBJECTINFO_PROPERTY_SETS, BLP_WEBOBJECTINFO_SUBTYPE, BLP_WEBOBJECTINFO_TYPE, isNewParam, localSymbolFolderXMLParam, metricIdParam, metricXMLParam, outputFlagsParam, PARAM_DESC_IS_NEW, PARAM_DESC_LOCAL_SYMBOL_FOLDER_XML, PARAM_DESC_METRIC_ID, PARAM_DESC_OUTPUT_FLAGS, PARAM_DESC_TOKEN_STREAM_XML, PARAM_NAME_IS_NEW, PARAM_NAME_LOCAL_SYMBOL_FOLDER_XML, PARAM_NAME_METRIC_ID, PARAM_NAME_OUTPUT_FLAGS, PARAM_NAME_TOKEN_STREAM_XML, tokenStreamXMLParam

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

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

addIsNewParam, addLocalSymbolFolderXMLParam, addMetricIdParam, addMetricXMLParam, addTokenStreamXMLParam, buildSingleFormat, createMetricBlock, setBasicProperties, setBasicProperties

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

Constructor Detail

GetMetricDefinitionTask

public GetMetricDefinitionTask()

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)