Package com.microstrategy.web.tasks

Class ReportBinaryResultsTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.tasks.AbstractResultSetResultsTask

com.microstrategy.web.tasks.AbstractResultSetBinaryResultsTask

com.microstrategy.web.tasks.ReportBinaryResultsTask

All Implemented Interfaces:

Task

public class ReportBinaryResultsTask
extends AbstractResultSetBinaryResultsTask

This Task provides the following functionality: it can retrieve the results associated with a Report in binary format.

Field Summary

Fields inherited from class com.microstrategy.web.tasks.AbstractResultSetBinaryResultsTask

resultDetailFlagsParam

Fields inherited from class com.microstrategy.web.tasks.AbstractResultSetResultsTask

MSG_PROMPT, MSG_TIMEOUT

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

Method Summary

Modifier and Type	Method	Description
protected byte[]	getBinaryResults(RequestKeys rk, java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, IntWrapper iwStatus)
protected java.lang.String	getClassName()
protected java.lang.String	getFileName(WebIServerSession session, java.lang.String msgID, int resultFlags)
protected int	getStatus(RequestKeys rk, java.lang.String sessionID)
protected void	sendBinaryResults(RequestKeys rk, java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, IntWrapper iwStatus, IContentConsumer consumer)

Methods inherited from class com.microstrategy.web.tasks.AbstractResultSetBinaryResultsTask

createResponse, preCollectData, sendBinary

Methods inherited from class com.microstrategy.web.tasks.AbstractResultSetResultsTask

getSession, pollStatus, processRequest

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, newRequestContext, 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

ReportBinaryResultsTask

public ReportBinaryResultsTask()

Method Detail

getStatus

protected int getStatus(RequestKeys rk,
                        java.lang.String sessionID)
                 throws MSTRWebAPIException

Specified by:

getStatus in class AbstractResultSetResultsTask

Throws:

MSTRWebAPIException

getBinaryResults

protected byte[] getBinaryResults(RequestKeys rk,
                                  java.lang.String sessionID,
                                  java.lang.String messageID,
                                  int resultFlags,
                                  int detailFlags,
                                  int stateID,
                                  IntWrapper iwStatus)
                           throws MSTRWebAPIException

Specified by:

getBinaryResults in class AbstractResultSetBinaryResultsTask

Throws:

MSTRWebAPIException

sendBinaryResults

protected void sendBinaryResults(RequestKeys rk,
                                 java.lang.String sessionID,
                                 java.lang.String messageID,
                                 int resultFlags,
                                 int detailFlags,
                                 int stateID,
                                 IntWrapper iwStatus,
                                 IContentConsumer consumer)
                          throws MSTRWebAPIException

Specified by:

sendBinaryResults in class AbstractResultSetBinaryResultsTask

Throws:

MSTRWebAPIException

getClassName

protected java.lang.String getClassName()

Overrides:

getClassName in class AbstractResultSetBinaryResultsTask

getFileName

protected java.lang.String getFileName(WebIServerSession session,
                                       java.lang.String msgID,
                                       int resultFlags)

Overrides:

getFileName in class AbstractResultSetBinaryResultsTask