public class

DocumentXMLResultsTask

extends AbstractBaseTask
java.lang.Object
   ↳ com.microstrategy.web.tasks.AbstractBaseTask
     ↳ com.microstrategy.web.tasks.DocumentXMLResultsTask

Class Overview

This Task 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).

Summary

Constants
String PARAM_NAME_DPI_PARAM The name of the DPI XML parameter.
String PARAM_NAME_EXT_PARAM The name of the Extendable_Parameter XML parameter.
[Expand]
Inherited Constants
From class com.microstrategy.web.tasks.AbstractBaseTask
Fields
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.
[Expand]
Inherited Fields
From class com.microstrategy.web.tasks.AbstractBaseTask
Public Constructors
DocumentXMLResultsTask()
Public Methods
void processRequest(TaskRequestContext context, TaskOutput taskOutput)
Retrieves the Intelligence Server session, sets the result flags, requests the results (waiting until results are finished).
Protected Methods
void checkForRequiredParameters(RequestKeys requestKeys)
Checks whether all required parameters are present or not.
[Expand]
Inherited Methods
From class com.microstrategy.web.tasks.AbstractBaseTask
From class java.lang.Object
From interface com.microstrategy.web.tasks.Task

Constants

public static final String PARAM_NAME_DPI_PARAM

The name of the DPI XML parameter.

Constant Value: "dpiParam"

public static final String PARAM_NAME_EXT_PARAM

The name of the Extendable_Parameter XML parameter.

Constant Value: "extParam"

Fields

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.

Public Constructors

public DocumentXMLResultsTask ()

Public Methods

public void processRequest (TaskRequestContext context, TaskOutput taskOutput)

Retrieves the Intelligence Server session, sets the result flags, requests the results (waiting until results are finished).

Parameters
context The TaskRequestContext object that maintains the state of the request.
taskOutput The TaskOutput 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.

Protected Methods

protected void checkForRequiredParameters (RequestKeys requestKeys)

Checks whether all required parameters are present or not.

Parameters
requestKeys The RequestKeys object that contains all parameters.