public class

TaskProcessorRequestState

extends Object
implements RequestState TaskStatusCodes
java.lang.Object
   ↳ com.microstrategy.web.controller.TaskProcessorRequestState

Class Overview

The RequestState object to used by the Task Processor.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.tasks.TaskStatusCodes
Public Constructors
TaskProcessorRequestState()
Creates a new TaskProcessorRequestState object.
Public Methods
boolean failure()
Returns whether the incoming request was a failure or not.
ContainerServices getContainerServices()
TaskOutput getGeneratedContent()
Returns the generated content for the task request.
String getProcessRequestErrorMessage()
Returns the error message associated with this process request.
int getProcessRequestStatusCode()
Returns the status code associated the task request.
Integer getProcessRequestTaskErrorCode()
Returns the task error code, if set.
RequestKeys getRequestKeys()
Returns the RequestKeys associated with this Task request.
TaskProcessor.TaskInvoker getTaskInvoker()
Returns task invoker role behind the request.
boolean isCompressionEnabled()
boolean requestIsComplete()
boolean serializeBinaryContent()
Whether the Task Processor Controller should attempt to serialize binary content generated by a Task directly to the Output Stream.
void setCompressionEnabled(boolean compressionEnabled)
void setContainerServices(ContainerServices cs)
void setGeneratedContent(TaskOutput taskOutput)
Sets the generated content for the task request.
void setProcessRequestErrorMessage(String errMsg)
Sets the error message associated with this process request.
void setProcessRequestStatusCode(int statusCode)
Sets the status code associated the task request.
void setProcessRequestTaskErrorCode(Integer taskErrorCode)
Sets the task-specific error code.
void setRequestIsComplete(boolean isComplete)
Indicates whether the request is complete--that is, fully sent to the output stream by the Task.
void setRequestKeys(RequestKeys requestKeys)
Sets the RequestKeys associated with this Task request.
void setSerializeBinaryContent(boolean serialize)
Sets whether the Task Processor Controller should serialize binary content generated by a Task directly to the Output Stream.
void setTaskInvoker(TaskProcessor.TaskInvoker taskInvoker)
Sets task invoker role to facilitate authorization in task displaying and execution.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.controller.RequestState

Public Constructors

public TaskProcessorRequestState ()

Creates a new TaskProcessorRequestState object.

Public Methods

public boolean failure ()

Returns whether the incoming request was a failure or not.

Returns
  • True if the incoming task request was not satisfied; otherwise, false.

public ContainerServices getContainerServices ()

public TaskOutput getGeneratedContent ()

Returns the generated content for the task request.

Returns
  • The generated content for the task request, in the form of a TaskOutput.

public String getProcessRequestErrorMessage ()

Returns the error message associated with this process request.

Returns
  • The error message associated with this process request.

public int getProcessRequestStatusCode ()

Returns the status code associated the task request.

Returns
  • The status code associated the task request.

public Integer getProcessRequestTaskErrorCode ()

Returns the task error code, if set.

Returns
  • The Task-specific error code.

public RequestKeys getRequestKeys ()

Returns the RequestKeys associated with this Task request.

Returns

public TaskProcessor.TaskInvoker getTaskInvoker ()

Returns task invoker role behind the request.

public boolean isCompressionEnabled ()

public boolean requestIsComplete ()

public boolean serializeBinaryContent ()

Whether the Task Processor Controller should attempt to serialize binary content generated by a Task directly to the Output Stream. By default, it is true.

Returns

public void setCompressionEnabled (boolean compressionEnabled)

public void setContainerServices (ContainerServices cs)

public void setGeneratedContent (TaskOutput taskOutput)

Sets the generated content for the task request.

Parameters
taskOutput The generated content for the task request.

public void setProcessRequestErrorMessage (String errMsg)

Sets the error message associated with this process request.

Parameters
errMsg The error message associated with this process request.

public void setProcessRequestStatusCode (int statusCode)

Sets the status code associated the task request.

Parameters
statusCode The status code associated the task request.

public void setProcessRequestTaskErrorCode (Integer taskErrorCode)

Sets the task-specific error code.

Parameters
taskErrorCode The task-specific error code.

public void setRequestIsComplete (boolean isComplete)

Indicates whether the request is complete--that is, fully sent to the output stream by the Task.

Parameters
isComplete True if the Task has fully completed the request, sending all content to the output stream; otherwise, False indicates that the Task Processor Controller must act to complete the request.

public void setRequestKeys (RequestKeys requestKeys)

Sets the RequestKeys associated with this Task request.

Parameters
requestKeys The RequestKeys object to use with this Task request.

public void setSerializeBinaryContent (boolean serialize)

Sets whether the Task Processor Controller should serialize binary content generated by a Task directly to the Output Stream. By default, it is true.

Parameters
serialize True to cause the TaskProcessorController to serialize binary content to the OutputStream; False causes it to remain in the MarkupOutput.

public void setTaskInvoker (TaskProcessor.TaskInvoker taskInvoker)

Sets task invoker role to facilitate authorization in task displaying and execution.

Parameters
taskInvoker the task invoker TaskProcessor.TaskInvoker