Package com.microstrategy.web.tasks
Class DocumentXMLResultsTask
- java.lang.Object
-
- com.microstrategy.web.tasks.AbstractBaseTask
-
- com.microstrategy.web.tasks.DocumentXMLResultsTask
-
- All Implemented Interfaces:
Task
public class DocumentXMLResultsTask extends AbstractBaseTask
ThisTask
provides the following functionality: it can retrieve the results associated with an executed Report Services document. If the document has not finished executing, it can poll for the results (observing a maximum wait time and a polling frequency value).- Since:
- MicroStrategy Web 8.1.0
-
-
Field Summary
Fields Modifier and Type Field Description protected TaskParameterMetadata
dpiParam
This is the optional dots per inch XML task parameter.protected TaskParameterMetadata
extParamXMLParam
This is the optional extendable_parameter XML task parameter.static java.lang.String
PARAM_NAME_DPI_PARAM
The name of the DPI XML parameter.static java.lang.String
PARAM_NAME_EXT_PARAM
The name of the Extendable_Parameter XML parameter.-
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 DocumentXMLResultsTask()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
checkForRequiredParameters(RequestKeys requestKeys)
Checks whether all required parameters are present or not.void
processRequest(TaskRequestContext context, TaskOutput taskOutput)
Retrieves the Intelligence Server session, sets the result flags, requests the results (waiting until results are finished).-
Methods inherited from class com.microstrategy.web.tasks.AbstractBaseTask
addExecFlagsParam, addJuilLayouts, addMaxWaitParam, addMaxWaitParam, addMessageIDParam, addObjectIDParam, addParameterMetadata, addParameterMetadata, addParameterMetadata, addPollingFrequencyParam, addPollingFrequencyParam, addResultFlagsParam, addSessionIDParam, addSessionStateParam, addStateIDParam, destroy, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, init, newRequestContext, processRequest, retrieveUploadedFile, setCompressOutput, setDescription, setID, setMetadata, setPrivileges, validateContentType
-
-
-
-
Field Detail
-
PARAM_NAME_EXT_PARAM
public static final java.lang.String PARAM_NAME_EXT_PARAM
The name of the Extendable_Parameter XML parameter.- See Also:
- Constant Field Values
-
PARAM_NAME_DPI_PARAM
public static final java.lang.String PARAM_NAME_DPI_PARAM
The name of the DPI XML parameter.- Since:
- MicroStrategy Web 8.1.2
- See Also:
- Constant Field Values
-
extParamXMLParam
protected TaskParameterMetadata extParamXMLParam
This is the optional extendable_parameter XML task parameter.
-
dpiParam
protected TaskParameterMetadata dpiParam
This is the optional dots per inch XML task parameter.- Since:
- MicroStrategy Web 8.1.2
-
-
Method Detail
-
processRequest
public void processRequest(TaskRequestContext context, TaskOutput taskOutput) throws TaskException
Retrieves the Intelligence Server session, sets the result flags, requests the results (waiting until results are finished).- Specified by:
processRequest
in interfaceTask
- Overrides:
processRequest
in classAbstractBaseTask
- Parameters:
context
- TheTaskRequestContext
object that maintains the state of the request.taskOutput
- TheTaskOutput
that records the contents of the Task response.- Throws:
TaskException
- If the Task cannot complete as expected.TaskInternalException
- If the Task encounters an error on the Intelligence Server.- Since:
- MicroStrategy Web 9.0.0
- See Also:
Task.processRequest(TaskRequestContext, TaskOutput)
-
checkForRequiredParameters
protected void checkForRequiredParameters(RequestKeys requestKeys) throws TaskRequestMalformedException
Description copied from class:AbstractBaseTask
Checks whether all required parameters are present or not.- Overrides:
checkForRequiredParameters
in classAbstractBaseTask
- Parameters:
requestKeys
- TheRequestKeys
object that contains all parameters.- Throws:
TaskRequestMalformedException
- If some required parameters are missing.- Since:
- MicroStrategy Web 8.1.1
-
-