Package com.microstrategy.web.app.tasks.QueryBuilder

Class GetReportXDADefinitionTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.app.tasks.AbstractAppTask

com.microstrategy.web.app.tasks.QueryBuilder.GetReportXDADefinitionTask

All Implemented Interfaces:

Task

public class GetReportXDADefinitionTask
extends AbstractAppTask

Field Summary

Fields

Modifier and Type	Field	Description
protected TaskParameterMetadata	attributeGroupInfoParam
protected TaskParameterMetadata	automapFlagTaskParam
protected TaskParameterMetadata	bindingFlagTaskParam
protected TaskParameterMetadata	browseTypeTaskParam
protected TaskParameterMetadata	documentIDTaskParam
protected TaskParameterMetadata	messageIDTaskParam
static java.lang.String	PARAM_AUTOMAP_FLAG
static java.lang.String	PARAM_BINDINGTABLE_FLAG
static java.lang.String	PARAM_BROWSE_TYPE
static java.lang.String	PARAM_DOCUMENT_ID
static java.lang.String	PARAM_MESSAGE_ID
static java.lang.String	PARAM_POLL
static java.lang.String	PARAM_PREVIEW_FLAG
static java.lang.String	PARAM_REPORT_ID
static java.lang.String	PARAM_SHEET_INDEX
static java.lang.String	PARAM_TABLE_ID
protected TaskParameterMetadata	pollTaskParam
protected TaskParameterMetadata	previewFlagTaskParam
protected TaskParameterMetadata	reportIDTaskParam
protected TaskParameterMetadata	selectedAttributeIdsParam
protected TaskParameterMetadata	sheetIndexTaskParam
protected TaskParameterMetadata	tableIDParam
static java.lang.String	XML_INDEX

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

Modifier	Constructor	Description
	GetReportXDADefinitionTask()
protected	GetReportXDADefinitionTask(java.lang.String description)

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	GetReportXDADefinitionCommand(java.lang.String sessionID, java.lang.String messageID, java.lang.String documentID, java.lang.String tableID, java.lang.String browseType, java.lang.String bindingFlag, java.lang.String previewFlag, java.lang.String automap, java.lang.String sheetIndex, WebReportInstance ri)
protected java.lang.String	GetReportXDADefinitionCommand2(java.lang.String sessionID, java.lang.String reportID, java.lang.String documentID, java.lang.String tableID, java.lang.String browseType, java.lang.String bindingFlag, java.lang.String previewFlag, java.lang.String automap, java.lang.String sheetIndex)
int	getRequestTimeout()
void	processRequest(TaskRequestContext context, TaskOutput taskOutput)	The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes the AbstractBaseTask.processRequest(TaskRequestContext, MarkupOutput) version.

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_BROWSE_TYPE

public static final java.lang.String PARAM_BROWSE_TYPE

See Also:

Constant Field Values

PARAM_MESSAGE_ID

public static final java.lang.String PARAM_MESSAGE_ID

See Also:

Constant Field Values

PARAM_REPORT_ID

public static final java.lang.String PARAM_REPORT_ID

See Also:

Constant Field Values

PARAM_BINDINGTABLE_FLAG

public static final java.lang.String PARAM_BINDINGTABLE_FLAG

See Also:

Constant Field Values

PARAM_PREVIEW_FLAG

public static final java.lang.String PARAM_PREVIEW_FLAG

See Also:

Constant Field Values

PARAM_AUTOMAP_FLAG

public static final java.lang.String PARAM_AUTOMAP_FLAG

See Also:

Constant Field Values

PARAM_SHEET_INDEX

public static final java.lang.String PARAM_SHEET_INDEX

See Also:

Constant Field Values

PARAM_POLL

public static final java.lang.String PARAM_POLL

See Also:

Constant Field Values

PARAM_DOCUMENT_ID

public static final java.lang.String PARAM_DOCUMENT_ID

See Also:

Constant Field Values

XML_INDEX

public static final java.lang.String XML_INDEX

See Also:

Constant Field Values

PARAM_TABLE_ID

public static final java.lang.String PARAM_TABLE_ID

See Also:

Constant Field Values

messageIDTaskParam

protected TaskParameterMetadata messageIDTaskParam

reportIDTaskParam

protected TaskParameterMetadata reportIDTaskParam

bindingFlagTaskParam

protected TaskParameterMetadata bindingFlagTaskParam

browseTypeTaskParam

protected TaskParameterMetadata browseTypeTaskParam

previewFlagTaskParam

protected TaskParameterMetadata previewFlagTaskParam

automapFlagTaskParam

protected TaskParameterMetadata automapFlagTaskParam

sheetIndexTaskParam

protected TaskParameterMetadata sheetIndexTaskParam

pollTaskParam

protected TaskParameterMetadata pollTaskParam

documentIDTaskParam

protected TaskParameterMetadata documentIDTaskParam

tableIDParam

protected TaskParameterMetadata tableIDParam

attributeGroupInfoParam

protected TaskParameterMetadata attributeGroupInfoParam

selectedAttributeIdsParam

protected TaskParameterMetadata selectedAttributeIdsParam

Constructor Detail

GetReportXDADefinitionTask

public GetReportXDADefinitionTask()

GetReportXDADefinitionTask

protected GetReportXDADefinitionTask(java.lang.String description)

Method Detail

processRequest

public void processRequest(TaskRequestContext context,
                           TaskOutput taskOutput)
                    throws TaskException

Description copied from class: AbstractBaseTask

The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes the AbstractBaseTask.processRequest(TaskRequestContext, MarkupOutput) version.

Specified by:

processRequest in interface Task

Overrides:

processRequest in class AbstractBaseTask

Parameters:

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

taskOutput - The TaskOutput that contains the output generated by the Task.

Throws:

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

See Also:

Task.processRequest(TaskRequestContext, TaskOutput)

GetReportXDADefinitionCommand

protected java.lang.String GetReportXDADefinitionCommand(java.lang.String sessionID,
                                                         java.lang.String messageID,
                                                         java.lang.String documentID,
                                                         java.lang.String tableID,
                                                         java.lang.String browseType,
                                                         java.lang.String bindingFlag,
                                                         java.lang.String previewFlag,
                                                         java.lang.String automap,
                                                         java.lang.String sheetIndex,
                                                         WebReportInstance ri)
                                                  throws TaskException

Throws:

TaskException

GetReportXDADefinitionCommand2

protected java.lang.String GetReportXDADefinitionCommand2(java.lang.String sessionID,
                                                          java.lang.String reportID,
                                                          java.lang.String documentID,
                                                          java.lang.String tableID,
                                                          java.lang.String browseType,
                                                          java.lang.String bindingFlag,
                                                          java.lang.String previewFlag,
                                                          java.lang.String automap,
                                                          java.lang.String sheetIndex)
                                                   throws TaskException

Throws:

TaskException

getRequestTimeout

public int getRequestTimeout()