Package de.xima.fc.workflow

Class GetAvailableResourcesParams

java.lang.Object

de.xima.fc.workflow.GetAvailableResourcesParams

All Implemented Interfaces:

Serializable

public final class GetAvailableResourcesParams
extends Object
implements Serializable

POJO with parameters for IWorkflowProvider.getAvailableResources(NodeKey, GetAvailableResourcesParams).

Since:

8.2.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GetAvailableResourcesParams.Builder	builder()	Creates a new builder for configuring a GetAvailableResourcesParams instance.
Set<String>	contentTypes()	A list of content types for filtering the returned resources.
static GetAvailableResourcesParams	defaults()	Gets a params instance with the defaults, which includes all types of attachments.
boolean	equals(Object o)
Set<String>	extensions()	A list of extensions for filtering the returned resources.
int	hashCode()
boolean	includeAttachmentSearch()	Whether to include attachments from an attachment file name search, i.e.
boolean	includeClientFile()	Whether to include client files, i.e.
boolean	includeExternal()	Whether to include external files, i.e.
boolean	includeFiredTrigger()	Whether to include attachments from fired triggers, i.e.
boolean	includeFormFile()	Whether to include attachments from form files, i.e.
boolean	includePreviousNode()	Whether to include attachments from previously executed workflow nodes, i.e.
boolean	includeUpload()	Whether to include attachments from upload elements, i.e.

Methods inherited from class java.lang.Object

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

Method Detail

contentTypes

public Set<String> contentTypes()

A list of content types for filtering the returned resources. When no content types are given, no filtering is applied, i.e.all resources are returned. When an item of this array contains a comma, it is split into several content types. So Set.of("text/plain,image/jpg") is the same as Set.of("text/plain", "image/jpg").

Returns:

The list of content types.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

extensions

public Set<String> extensions()

A list of extensions for filtering the returned resources. When no extensions are given, no filtering is applied, i.e.all resources are returned. When an item of this array contains a comma, it is split into several extension. So Set.of("pdf,docx") is the same as Set.of("pdf", "docx").

Returns:

The list of extensions.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

includeAttachmentSearch

public boolean includeAttachmentSearch()

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

Returns:

Whether to include attachments form previous nodes.

includeClientFile

public boolean includeClientFile()

Whether to include client files, i.e. attachment items of type CLIENT.

Returns:

Whether to include attachments from client files.

includeExternal

public boolean includeExternal()

Whether to include external files, i.e. attachment items of type EXTERNAL.

Returns:

Whether to include attachments from external files.

includeFiredTrigger

public boolean includeFiredTrigger()

Whether to include attachments from fired triggers, i.e. attachment items of type FIRED_TRIGGER.

Returns:

Whether to include attachments from fired triggers.

includeFormFile

public boolean includeFormFile()

Whether to include attachments from form files, i.e. attachment items of type FORM.

Returns:

Whether to include attachments from form files.

includePreviousNode

public boolean includePreviousNode()

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

Returns:

Whether to include attachments form previous nodes.

includeUpload

public boolean includeUpload()

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 GetAvailableResourcesParams.Builder builder()

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

Returns:

A new builder for a params instance.

defaults

public static GetAvailableResourcesParams defaults()

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

Returns:

A params instance with the defaults.