Package de.xima.fc.logic.form_record.chat

Class DefaultExtendedFulfillRequestedUploadRequest

java.lang.Object

de.xima.fc.logic.form_record.chat.DefaultExtendedFulfillRequestedUploadRequest

All Implemented Interfaces:

IExtendedFulfillRequestedUploadRequest

public final class DefaultExtendedFulfillRequestedUploadRequest
extends Object
implements IExtendedFulfillRequestedUploadRequest

Simple POJO implementation of an IExtendedFulfillRequestedUploadRequest with a builder.

Since:

8.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultExtendedFulfillRequestedUploadRequest.Builder	Builder for a DefaultExtendedFulfillRequestedUploadRequest.

Method Summary

Modifier and Type	Method	Description
IFulfillRequestedUploadRequest	baseRequest()	The base request data for fulfilling a form record message upload request.
IEntityContext	entityContext()	Gets the entity context to use for posting the message.
static DefaultExtendedFulfillRequestedUploadRequest.Builder	extendedFulfillRequestedUploadRequestBuilder(FormRecordMessageUploadRequest uploadRequest)	Creates a new builder for an IExtendedFulfillRequestedUploadRequest that fulfills the given upload request.
static DefaultExtendedFulfillRequestedUploadRequest.Builder	extendedFulfillRequestedUploadRequestBuilder(UUID uploadRequestUuid)	Creates a new builder for an IExtendedFulfillRequestedUploadRequest that fulfills the given upload request.
IWorkflowExecutionContext	workflowContext()	Optional.

Methods inherited from class java.lang.Object

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

Method Detail

baseRequest

public IFulfillRequestedUploadRequest baseRequest()

Description copied from interface: IExtendedFulfillRequestedUploadRequest

The base request data for fulfilling a form record message upload request.

Specified by:

baseRequest in interface IExtendedFulfillRequestedUploadRequest

Returns:

The base request data for fulfilling a form record message upload request.

entityContext

public IEntityContext entityContext()

Description copied from interface: IExtendedFulfillRequestedUploadRequest

Gets the entity context to use for posting the message. By default, a new entity context is created. Should be used with caution.

Specified by:

entityContext in interface IExtendedFulfillRequestedUploadRequest

Returns:

The entity context to use for posting the message.

workflowContext

public IWorkflowExecutionContext workflowContext()

Description copied from interface: IExtendedFulfillRequestedUploadRequest

Optional. The active workflow context that issued the fulfill requested upload request.

After the upload request was fulfilled, a workflow event is triggered, which in turn may trigger a workflow execution. This will fail when a workflow execution is currently in progress. To avoid this, the workflow context should be given. When a workflow context is given, the matching tasks will be added to the current execution queue instead. This also prevents potential endless loops when a workflow task reacting to a message event posts a message itself, as there exists a hard limit on the maximum number of executed nodes per workflow execution.

Specified by:

workflowContext in interface IExtendedFulfillRequestedUploadRequest

Returns:

The workflow execution context containing the action that issued the post message request.

extendedFulfillRequestedUploadRequestBuilder

public static DefaultExtendedFulfillRequestedUploadRequest.Builder extendedFulfillRequestedUploadRequestBuilder(UUID uploadRequestUuid)

Creates a new builder for an IExtendedFulfillRequestedUploadRequest that fulfills the given upload request.

Parameters:

uploadRequestUuid - UUID of the upload request to fulfill.

Returns:

A new builder for an IExtendedFulfillRequestedUploadRequest.

extendedFulfillRequestedUploadRequestBuilder

public static DefaultExtendedFulfillRequestedUploadRequest.Builder extendedFulfillRequestedUploadRequestBuilder(FormRecordMessageUploadRequest uploadRequest)

Creates a new builder for an IExtendedFulfillRequestedUploadRequest that fulfills the given upload request.

Parameters:

uploadRequest - The upload request to fulfill.

Returns:

A new builder for an IExtendedFulfillRequestedUploadRequest.