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

Class SingleFile

java.lang.Object

de.xima.fc.workflow.model.nodes.SingleFile

All Implemented Interfaces:

IReferencedFileList, ISingleFileProviding, Serializable

@NotEmptyIf(field="url",dependants="resource",target=SingleFile.class,payload=url.class) @NotEmptyIf(field="searchFilename",dependants="resource",target=SingleFile.class,payload=searchFilename.class)
public final class SingleFile
extends Object
implements Serializable, ISingleFileProviding

Models a single file that may come from multiple sources, such as client file, project files or external files referenced via a URL.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SingleFile.resource	Custom label for the getResource() property.
static interface	SingleFile.searchFilename	Custom label for the getSearchFilename() property.
static interface	SingleFile.url	Custom label for the getUrl() property.

Constructor Summary

Constructors

Constructor	Description
SingleFile()

Method Summary

Modifier and Type	Method	Description
static SingleFile	forAttachmentSearch(String searchName, EAttachmentSource... attachmentFilter)
static SingleFile	forAttachmentSearch(String searchName, Iterable<EAttachmentSource> attachmentFilter)
static SingleFile	forClientFile(MandantRessource clientFile)
static SingleFile	forClientFile(UuidEntityRef clientFileRef)
static SingleFile	forExternal(String url)
static SingleFile	forFormFile(ProjektRessource formFile)
static SingleFile	forFormFile(UuidEntityRef formFileRef)
static SingleFile	forUploadElement(String identifier)
static SingleFile	forWorkflowNode(NodeKey nodeKey)
List<EAttachmentSource>	getAttachmentFilter()
int	getConnectionTimeout()
int	getReadTimeout()
ResourceItem	getResource()
String	getSearchFilename()
String	getUrl()
void	setAttachmentFilter(List<EAttachmentSource> attachmentFilter)
void	setConnectionTimeout(int connectionTimeout)
void	setReadTimeout(int readTimeout)
void	setResource(ResourceItem resource)
void	setSearchFilename(String searchName)
void	setUrl(String url)

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.ISingleFileProviding

getResources, getUrls

Constructor Detail

SingleFile

public SingleFile()

Method Detail

getAttachmentFilter

public List<EAttachmentSource> getAttachmentFilter()

Specified by:

getAttachmentFilter in interface IReferencedFileList

Specified by:

getAttachmentFilter in interface ISingleFileProviding

Returns:

Attachment sources to which to restrict the search for attachments, if a resource item of type EResourceItemType.EXTERNAL exists.

getConnectionTimeout

public int getConnectionTimeout()

Specified by:

getConnectionTimeout in interface IReferencedFileList

Specified by:

getConnectionTimeout in interface ISingleFileProviding

Returns:

a connection time-out for an external resource retrieval

getReadTimeout

public int getReadTimeout()

Specified by:

getReadTimeout in interface IReferencedFileList

Specified by:

getReadTimeout in interface ISingleFileProviding

Returns:

a read time-out for an external resource retrieval

getResource

@Nullable
public ResourceItem getResource()

Specified by:

getResource in interface ISingleFileProviding

Returns:

The resource item for the file.

getSearchFilename

public String getSearchFilename()

Specified by:

getSearchFilename in interface IReferencedFileList

Specified by:

getSearchFilename in interface ISingleFileProviding

Returns:

Pattern for searching for an attachment, if a resource item of type EResourceItemType.ATTACHMENT_SEARCH exists. null or empty when no such resource item exists.

getUrl

public String getUrl()

Specified by:

getUrl in interface ISingleFileProviding

Returns:

null, or the resource path, if ResourceItem.getType() is an EResourceItemType.EXTERNAL resource.

setAttachmentFilter

public void setAttachmentFilter(List<EAttachmentSource> attachmentFilter)

Parameters:

attachmentFilter - restrictions of type EAttachmentSource for the search filename term. Is only used if ResourceItem.getType() is an EResourceItemType.ATTACHMENT_SEARCH resource

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

Parameters:

connectionTimeout - in seconds for an external retrieval of a resource

setReadTimeout

public void setReadTimeout(int readTimeout)

Parameters:

readTimeout - in seconds for an external retrieval of a resource

setResource

public void setResource(@Nullable
                        ResourceItem resource)

Parameters:

resource - The resource item for the file. When null, no resource is selected.

setSearchFilename

public void setSearchFilename(String searchName)

Parameters:

searchName - null, or the search filename term, if ResourceItem.getType() is an EResourceItemType.ATTACHMENT_SEARCH resource

setUrl

public void setUrl(String url)

Parameters:

url - null, or the resource path, if ResourceItem.getType() is an EResourceItemType.EXTERNAL resource.

forAttachmentSearch

public static SingleFile forAttachmentSearch(String searchName,
                                             EAttachmentSource... attachmentFilter)

Parameters:

searchName - Name by which to search for attachments.

attachmentFilter - Attachments types to which to limit the search.

Returns:

A new single file for the attachment search option.

forAttachmentSearch

public static SingleFile forAttachmentSearch(String searchName,
                                             Iterable<EAttachmentSource> attachmentFilter)

Parameters:

searchName - Name by which to search for attachments.

attachmentFilter - Attachments types to which to limit the search.

Returns:

A new single file for the attachment search option.

forClientFile

public static SingleFile forClientFile(MandantRessource clientFile)

Parameters:

clientFile - A client file to use.

Returns:

A new single file for a client file resource.

forClientFile

public static SingleFile forClientFile(UuidEntityRef clientFileRef)

Parameters:

clientFileRef - A reference to the MandantRessource entity.

Returns:

A new single file for a client file resource.

forExternal

public static SingleFile forExternal(String url)

Parameters:

url - URL from which to retrieve the data.

Returns:

A new single file for an external resource option.

forFormFile

public static SingleFile forFormFile(ProjektRessource formFile)

Parameters:

formFile - A form file to use.

Returns:

A new single file for a form file resource.

forFormFile

public static SingleFile forFormFile(UuidEntityRef formFileRef)

Parameters:

formFileRef - A reference to the ProjektRessource entity.

Returns:

A new single file for a form file resource.

forUploadElement

public static SingleFile forUploadElement(String identifier)

Parameters:

identifier - The name of the file upload form element.

Returns:

A new single file for an external resource option.

forWorkflowNode

public static SingleFile forWorkflowNode(NodeKey nodeKey)

Parameters:

nodeKey - Key of the node to reference.

Returns:

A new single file representing the files produced by a workflow node.