Package de.xima.fc.workflow.model

Class TaskExecutionResultWrapper

java.lang.Object

de.xima.fc.workflow.model.TaskExecutionResultWrapper

All Implemented Interfaces:

IWorkflowResponse, IServletResponse, Serializable

public class TaskExecutionResultWrapper
extends Object
implements IWorkflowResponse, Serializable

Wrapper to treat a IRemoteEventExecutionResult as a IWorkflowResponse.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TaskExecutionResultWrapper(IRemoteEventExecutionResult result)

Method Summary

Modifier and Type	Method	Description
byte[]	getBinValue()	The binary data for the response.
String	getContentType()	Applies only when type is set to SHOW_FILE:
String	getEncoding()	Applies only when type is set to TEMPLATE, TEMPLATE_SYSTEM, or HTML.
long	getLongValue()	Applies only when type is set to FORM_RECORD is set, this is the ID of the form record to which to redirect.
ETextbausteinMsgCode	getMsgCode()
Map<String,Serializable>	getSessionAttributes()
EResponseType	getType()
String	getValue()	When type is set to a binary response type (e.g.
Vorgang	getVorgang()
boolean	isForceDownload()	Applies only when type is set to SHOW_FILE.
boolean	isSuccess()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.xima.fc.interfaces.servlet.IServletResponse

getFormTheme, getHttpHeader, getHttpStatusCode

Constructor Detail

TaskExecutionResultWrapper

public TaskExecutionResultWrapper(IRemoteEventExecutionResult result)

Method Detail

getValue

public String getValue()

Description copied from interface: IServletResponse

When type is set to a binary response type (e.g. SHOW_FILE), the file name of the returned file.

When type is set to a non-binary response (e.g. JSON), the plain-text content of the response.

When type is set to REDIRECT, the URL to which to redirect.

Specified by:

getValue in interface IServletResponse

Returns:

The plain-text content of the HTTP response.

getContentType

public String getContentType()

Description copied from interface: IServletResponse

Applies only when type is set to SHOW_FILE:

Must return the content type (=mime type) that is to be sent along with the binary data. When this is either null or blank, an attempt is made to guess the content type from the binary data. Please note that this may fail to determine the actual content type, you should always provide a content type.

Specified by:

getContentType in interface IServletResponse

Returns:

The content type of the binary data.

getSessionAttributes

public Map<String,Serializable> getSessionAttributes()

Specified by:

getSessionAttributes in interface IServletResponse

Returns:

A Map with attributes that should be written to the HttpSession. Existing values in the HttpSession are overwritten.

getType

public EResponseType getType()

Specified by:

getType in interface IServletResponse

Returns:

The type of response, such as whether a plain text or binary file should be returned, or a redirect should be performed.

getBinValue

public byte[] getBinValue()

Description copied from interface: IServletResponse

The binary data for the response. Applies only when type is set to SHOW_FILE.

Specified by:

getBinValue in interface IServletResponse

Returns:

The binary content of the HTTP response.

isForceDownload

public boolean isForceDownload()

Description copied from interface: IServletResponse

Applies only when type is set to SHOW_FILE.

Specified by:

isForceDownload in interface IServletResponse

Returns:

If true, attempts to prevent browsers from showing the binary content inline. If false, the browser may show the content inline, which is useful for PDF, image or plain text files. Please note that support for this differs between browsers.

getEncoding

public String getEncoding()

Description copied from interface: IServletResponse

Applies only when type is set to TEMPLATE, TEMPLATE_SYSTEM, or HTML.

Specified by:

getEncoding in interface IServletResponse

Returns:

The encoding that is to be used for encoding the response.

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface IWorkflowResponse

Returns:

true indicates that the workflow was run successfully, false indicates that an error occurred during workflow processing.

getMsgCode

public ETextbausteinMsgCode getMsgCode()

Specified by:

getMsgCode in interface IWorkflowResponse

Returns:

The response text that should be sent to the browser as a result of running the workflow. This may be a success, an error, or some other more specific message.

getVorgang

public Vorgang getVorgang()

Specified by:

getVorgang in interface IWorkflowResponse

Returns:

The current Vorgang that was processed.

getLongValue

public long getLongValue()

Description copied from interface: IServletResponse

Applies only when type is set to FORM_RECORD is set, this is the ID of the form record to which to redirect.

Specified by:

getLongValue in interface IServletResponse

Returns:

The long value content for the response.