Package de.xima.fc.workflow.model

Class RemoteEventExecutionResult

java.lang.Object

de.xima.fc.workflow.model.RemoteEventExecutionResult

All Implemented Interfaces:

IRemoteEventExecutionResult, Serializable

public final class RemoteEventExecutionResult
extends Object
implements IRemoteEventExecutionResult

Default POJO implementation of IRemoteEventExecutionResult.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
RemoteEventExecutionResult(boolean wasSuccessful, Vorgang formRecord, boolean wasFormRecordDeleted, IServletResponse servletResponse, IFormDataAdapter formDataAdapter, IMapDiff<String,Serializable> sessionAttributesMapDiff, String errorMessage, String[] stackTrace)	Creates a new POJO with the given data.

Method Summary

Modifier and Type	Method	Description
String	getErrorMessage()
IFormDataAdapter	getFormDataAdapter()
Vorgang	getFormRecord()
IServletResponse	getServletResponse()
IMapDiff<String,Serializable>	getSessionAttributesMapDiff()
String[]	getStackTrace()
boolean	isWasFormRecordDeleted()
boolean	isWasSuccessful()

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteEventExecutionResult

public RemoteEventExecutionResult(boolean wasSuccessful,
                                  Vorgang formRecord,
                                  boolean wasFormRecordDeleted,
                                  IServletResponse servletResponse,
                                  IFormDataAdapter formDataAdapter,
                                  IMapDiff<String,Serializable> sessionAttributesMapDiff,
                                  String errorMessage,
                                  String[] stackTrace)

Creates a new POJO with the given data.

Parameters:

wasSuccessful - The value as returned by isWasSuccessful().

formRecord - The value as returned by getFormRecord().

wasFormRecordDeleted - The value as returned by isWasFormRecordDeleted().

servletResponse - The value as returned by getServletResponse().

formDataAdapter - The value as returned by getFormDataAdapter().

sessionAttributesMapDiff - The value as returned by getSessionAttributesMapDiff().

errorMessage - The value as returned by getErrorMessage().

stackTrace - The value as returned by getStackTrace().

Method Detail

isWasSuccessful

public boolean isWasSuccessful()

Specified by:

isWasSuccessful in interface IRemoteEventExecutionResult

Returns:

Whether the workflow execution was successful.

getErrorMessage

public String getErrorMessage()

Specified by:

getErrorMessage in interface IRemoteEventExecutionResult

Returns:

If the workflow execution was not successful: the error message. Empty string otherwise.

getStackTrace

public String[] getStackTrace()

Specified by:

getStackTrace in interface IRemoteEventExecutionResult

Returns:

If the workflow execution was not successful: the error call stack. Empty array otherwise.

getServletResponse

public IServletResponse getServletResponse()

Specified by:

getServletResponse in interface IRemoteEventExecutionResult

Returns:

The servlet response set by the workflow execution, i.e. the response to the HTTP request, if any. null if no response was set explicitly. This response, if set, should be returned.

getFormRecord

public Vorgang getFormRecord()

Specified by:

getFormRecord in interface IRemoteEventExecutionResult

Returns:

The updated form record. The workflow execution may change the data of the form record, so this might be a different instance with different data than the form record passed in to the workflow executor.

isWasFormRecordDeleted

public boolean isWasFormRecordDeleted()

Specified by:

isWasFormRecordDeleted in interface IRemoteEventExecutionResult

Returns:

true when the form record was deleted by the workflow execution, i.e. when an action of type delete form record was executed.

getSessionAttributesMapDiff

public IMapDiff<String,Serializable> getSessionAttributesMapDiff()

Specified by:

getSessionAttributesMapDiff in interface IRemoteEventExecutionResult

Returns:

Changes to HTTP session attributes requested during workflow execution by some workflow node or action. These should be applied to the current HTTP session.

getFormDataAdapter

public IFormDataAdapter getFormDataAdapter()

Specified by:

getFormDataAdapter in interface IRemoteEventExecutionResult

Returns:

The current form data of the form record. The form data may have changed by some workflow node or action.