Package de.xima.fc.workflow.model.nodes

Class SingleAttachment

java.lang.Object

de.xima.fc.workflow.model.nodes.SingleAttachment

All Implemented Interfaces:

IReferencedAttachmentList, ISingleAttachmentProviding, Serializable

@NotEmptyIf(field="searchFilenamePattern",
            dependants="attachment",
            target=SingleAttachment.class,
            payload=searchFilenamePattern.class)
public final class SingleAttachment
extends Object
implements Serializable, ISingleAttachmentProviding

Models a single attachment that may come from one of multiple sources, such as upload form elements, creates by another action, or with a specific name.

Since:

8.1.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SingleAttachment.attachment	Custom label for the getAttachment() property.
static interface	SingleAttachment.searchFilenamePattern	Custom label for the getSearchFilenamePattern() property.

Constructor Summary

Constructors

Constructor	Description
SingleAttachment()

Method Summary

Modifier and Type	Method	Description
static SingleAttachment	forSearch(String filenamePattern, EAttachmentSource... sourceTypes)	Creates a single attachment reference that searches for an existing attachment by its file name and type.
static SingleAttachment	forSearch(String filenamePattern, Iterable<EAttachmentSource> sourceTypes)	Creates a single attachment reference that searches for an existing attachment by its file name and type.
static SingleAttachment	forUploadElement(String uploadElementName)	Creates a single attachment reference for the attachment created automatically by a file upload form element.
static SingleAttachment	forWorkflowNode(NodeKey nodeKey)	Creates a single attachment references for the attachment created by a previously executed workflow node.
AttachmentItem	getAttachment()
String	getSearchFilenamePattern()	Gets the pattern for searching for an attachment.
List<EAttachmentSource>	getSearchSourceTypes()	Gets the attachment sources to which to restrict the search for attachments.
void	setAttachment(AttachmentItem attachment)	Sets the attachment item for the selected attachment.
void	setSearchFilenamePattern(String searchFilenamePattern)	Sets the pattern for searching for an attachment, if an attachment item of type * SEARCH exists.
void	setSearchSourceTypes(List<EAttachmentSource> searchSourceTypes)	Sets the attachment source types to which to limit the search for attachments when an attachment item of type SEARCH is selected.

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.workflow.execution.ISingleAttachmentProviding

getAttachments

Constructor Detail

SingleAttachment

public SingleAttachment()

Method Detail

getAttachment

public AttachmentItem getAttachment()

Specified by:

getAttachment in interface ISingleAttachmentProviding

Returns:

The attachment item for the selected attachment.

setAttachment

public void setAttachment(@Nullable
                          AttachmentItem attachment)

Sets the attachment item for the selected attachment.

Parameters:

attachment - The selected attachment item.

getSearchFilenamePattern

public String getSearchFilenamePattern()

Description copied from interface: IReferencedAttachmentList

Gets the pattern for searching for an attachment. Applies only if an attachment item of type SEARCH exists. null or empty when no such attachment item exists.

Specified by:

getSearchFilenamePattern in interface IReferencedAttachmentList

Returns:

Pattern for searching for an attachment.

setSearchFilenamePattern

public void setSearchFilenamePattern(String searchFilenamePattern)

Sets the pattern for searching for an attachment, if an attachment item of type * SEARCH exists. null or empty when no such attachment item exists.

Parameters:

searchFilenamePattern - Search pattern for the attachment search.

getSearchSourceTypes

@Nonnull
public List<EAttachmentSource> getSearchSourceTypes()

Description copied from interface: IReferencedAttachmentList

Gets the attachment sources to which to restrict the search for attachments. Applies only if an attachment item of type SEARCH exists.

Specified by:

getSearchSourceTypes in interface IReferencedAttachmentList

Returns:

The attachment types to which to limit the search for attachments.

setSearchSourceTypes

public void setSearchSourceTypes(List<EAttachmentSource> searchSourceTypes)

Sets the attachment source types to which to limit the search for attachments when an attachment item of type SEARCH is selected.

Parameters:

searchSourceTypes - Attachment sources to which to limit the search.

forSearch

public static SingleAttachment forSearch(String filenamePattern,
                                         Iterable<EAttachmentSource> sourceTypes)

Creates a single attachment reference that searches for an existing attachment by its file name and type.

Parameters:

filenamePattern - Pattern that the file name of the attachment must match.

sourceTypes - Attachments types to which to limit the search.

Returns:

A new single attachment reference for searching an attachment by its name and type.

forSearch

public static SingleAttachment forSearch(String filenamePattern,
                                         EAttachmentSource... sourceTypes)

Creates a single attachment reference that searches for an existing attachment by its file name and type.

Parameters:

filenamePattern - Pattern that the file name of the attachment must match.

sourceTypes - Attachments types to which to limit the search.

Returns:

A new single attachment reference for searching an attachment by its name and type.

forUploadElement

public static SingleAttachment forUploadElement(String uploadElementName)

Creates a single attachment reference for the attachment created automatically by a file upload form element.

Parameters:

uploadElementName - The name of the file upload form element.

Returns:

A new single attachment reference for the attachment of a file upload element.

forWorkflowNode

public static SingleAttachment forWorkflowNode(NodeKey nodeKey)

Creates a single attachment references for the attachment created by a previously executed workflow node.

Parameters:

nodeKey - Key of the referenced workflow node.

Returns:

A new single attachment reference for the attachment produced by a workflow node.