Package com.microstrategy.web.tasks

Class AbstractResultSetResultsTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.tasks.AbstractResultSetResultsTask

All Implemented Interfaces:

Task

Direct Known Subclasses:

AbstractResultSetBinaryResultsTask, SaveRWTransactions, SetConditionalTransactionTask

public abstract class AbstractResultSetResultsTask
extends AbstractBaseTask

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	MSG_PROMPT
protected static java.lang.String	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
AbstractResultSetResultsTask(java.lang.String desc)

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	createResponse(TaskRequestContext context, TaskOutput output)
protected WebIServerSession	getSession(TaskRequestContext context)
protected abstract int	getStatus(RequestKeys rk, java.lang.String sessionID)
protected void	pollStatus(TaskRequestContext context, TaskOutput taskOutput)
protected abstract void	preCollectData(TaskRequestContext context, TaskOutput taskOutput)
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, 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

Field Detail

MSG_TIMEOUT

protected static final java.lang.String MSG_TIMEOUT

See Also:

Constant Field Values

MSG_PROMPT

protected static final java.lang.String MSG_PROMPT

See Also:

Constant Field Values

Constructor Detail

AbstractResultSetResultsTask

public AbstractResultSetResultsTask(java.lang.String desc)

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 interface Task

Overrides:

processRequest in class AbstractBaseTask

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.

See Also:

Task.processRequest(TaskRequestContext, TaskOutput)

pollStatus

protected void pollStatus(TaskRequestContext context,
                          TaskOutput taskOutput)
                   throws MSTRWebAPIException,
                          TaskException,
                          WebObjectsException

Throws:

MSTRWebAPIException

TaskException

WebObjectsException

getSession

protected WebIServerSession getSession(TaskRequestContext context)
                                throws TaskException

Throws:

TaskException

preCollectData

protected abstract void preCollectData(TaskRequestContext context,
                                       TaskOutput taskOutput)
                                throws TaskException,
                                       WebObjectsException,
                                       MSTRWebAPIException

Throws:

TaskException

WebObjectsException

MSTRWebAPIException

getStatus

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

Throws:

MSTRWebAPIException

createResponse

protected abstract boolean createResponse(TaskRequestContext context,
                                          TaskOutput output)
                                   throws MSTRWebAPIException,
                                          TaskException,
                                          WebObjectsException

Throws:

MSTRWebAPIException

TaskException

WebObjectsException