Package de.xima.fc.workflow

Class GetAvailableAttachmentsParams

java.lang.Object

de.xima.fc.workflow.GetAvailableAttachmentsParams

public final class GetAvailableAttachmentsParams
extends Object

POJO with parameters for IWorkflowProvider.getAvailableAttachments(NodeKey, GetAvailableAttachmentsParams).

Since:

8.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GetAvailableAttachmentsParams.Builder	A simple builder for configuring a GetAvailableAttachmentsParams POJO.

Method Summary

Modifier and Type	Method	Description
static GetAvailableAttachmentsParams.Builder	builder()	Creates a new builder for configuring a GetAvailableAttachmentsParams instance.
static GetAvailableAttachmentsParams	defaults()	Gets a params instance with the defaults, which includes all types of attachments.
boolean	isIncludePreviousNode()	Whether to include attachments from previously executed workflow nodes, i.e.
boolean	isIncludeSearch()	Whether to include attachments from an attachment file name search, i.e.
boolean	isIncludeUpload()	Whether to include attachments from upload elements, i.e.

Methods inherited from class java.lang.Object

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

Method Details

isIncludePreviousNode

public boolean isIncludePreviousNode()

Whether to include attachments from previously executed workflow nodes, i.e. attachment items of type PREVIOUS_NODE.

Returns:

Whether to include attachments form previous nodes.

isIncludeSearch

public boolean isIncludeSearch()

Whether to include attachments from an attachment file name search, i.e. attachment items of type SEARCH.

Returns:

Whether to include attachments form previous nodes.

isIncludeUpload

public boolean isIncludeUpload()

Whether to include attachments from upload elements, i.e. attachment items of type UPLOAD.

Returns:

Whether to include attachments form previous nodes.

builder

public static GetAvailableAttachmentsParams.Builder builder()

Creates a new builder for configuring a GetAvailableAttachmentsParams instance. The returned builder starts with the defaults().

Returns:

A new builder for a params instance.

defaults

public static GetAvailableAttachmentsParams defaults()

Gets a params instance with the defaults, which includes all types of attachments.

Returns:

A params instance with the defaults.