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

Class MultiFile

java.lang.Object

de.xima.fc.workflow.model.nodes.MultiFile

All Implemented Interfaces:

IMultiFileProviding, IReferencedFileList, Serializable

@NotEmptyIf(field="urls",dependants="resources",target=MultiFile.class,payload=urls.class) @NotEmptyIf(field="searchFilename",dependants="resources",target=MultiFile.class,payload=searchFilename.class)
public final class MultiFile
extends Object
implements Serializable, IMultiFileProviding

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

Use of this class is optional. However, its use is strongly recommended for consistency. This model comes with a pre-defined XHTML UI page for configuring instances of this class. During execution, the INodeExecutionParams and IWorkflowExecutionContext contain helper method to handle the options provided by this class. New options or features may be added to this class in the future. If you make use of this class, your action will gain access to these new features without any changes to your code.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MultiFile.resources	Custom label for the getResources() property.
static interface	MultiFile.searchFilename	Custom label for the getSearchFilename() property.
static interface	MultiFile.urls	Custom label for the getUrls() property.

Constructor Summary

Constructors

Constructor	Description
MultiFile()

Method Summary

Modifier and Type	Method	Description
static MultiFile	forAttachmentSearch(String attachmentSearchName, EAttachmentSource... attachmentSources)
static MultiFile	forExternalUrls(String... urls)
static MultiFile	forFiles(Iterable<ResourceItem> resourceItems, Iterable<String> urls, Iterable<EAttachmentSource> attachmentSources, String attachmentSearchName)
static MultiFile	forResourceItems(ResourceItem... items)
List<EAttachmentSource>	getAttachmentFilter()
int	getConnectionTimeout()
int	getReadTimeout()
List<ResourceItem>	getResources()
String	getSearchFilename()
List<String>	getUrls()
boolean	isResourceItemTypeSelected(EResourceItemType resourceItemType)
void	setAttachmentFilter(List<EAttachmentSource> attachmentFilter)
void	setConnectionTimeout(int connectionTimeout)
void	setReadTimeout(int readTimeout)
void	setResources(List<ResourceItem> resources)
void	setSearchFilename(String searchName)
void	setUrls(List<String> urls)

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiFile

public MultiFile()

Method Detail

getAttachmentFilter

public List<EAttachmentSource> getAttachmentFilter()

Specified by:

getAttachmentFilter in interface IMultiFileProviding

Specified by:

getAttachmentFilter in interface IReferencedFileList

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 IMultiFileProviding

Specified by:

getConnectionTimeout in interface IReferencedFileList

Returns:

a connection time-out for an external resource retrieval

getReadTimeout

public int getReadTimeout()

Specified by:

getReadTimeout in interface IMultiFileProviding

Specified by:

getReadTimeout in interface IReferencedFileList

Returns:

a read time-out for an external resource retrieval

getResources

public List<ResourceItem> getResources()

Specified by:

getResources in interface IMultiFileProviding

Specified by:

getResources in interface IReferencedFileList

Returns:

All resource items pointing to the files.

getSearchFilename

public String getSearchFilename()

Specified by:

getSearchFilename in interface IMultiFileProviding

Specified by:

getSearchFilename in interface IReferencedFileList

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.

getUrls

public List<String> getUrls()

Specified by:

getUrls in interface IMultiFileProviding

Specified by:

getUrls in interface IReferencedFileList

Returns:

All URLs from which to read data, if a resource item of type EResourceItemType.EXTERNAL exists.

isResourceItemTypeSelected

public boolean isResourceItemTypeSelected(EResourceItemType resourceItemType)

Specified by:

isResourceItemTypeSelected in interface IMultiFileProviding

Parameters:

resourceItemType - a String that can be converted into a EResourceItemType

Returns:

true if there is at least one element with the specified resource item type in the list of resources. Otherwise returns false

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

setResources

public void setResources(List<ResourceItem> resources)

Parameters:

resources - a list of ResourceItems

setSearchFilename

public void setSearchFilename(String searchName)

Parameters:

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

setUrls

public void setUrls(List<String> urls)

Parameters:

urls - List or the resource paths.

forAttachmentSearch

public static MultiFile forAttachmentSearch(String attachmentSearchName,
                                            EAttachmentSource... attachmentSources)

Parameters:

attachmentSearchName - Pattern for the name of attachments to find.

attachmentSources - Attachment sources to find.

Returns:

A multi file referencing the given attachment.

forExternalUrls

public static MultiFile forExternalUrls(String... urls)

Parameters:

urls - External resource URLs to read.

Returns:

A multi file referencing the given URLs.

forFiles

public static MultiFile forFiles(Iterable<ResourceItem> resourceItems,
                                 Iterable<String> urls,
                                 Iterable<EAttachmentSource> attachmentSources,
                                 String attachmentSearchName)

Parameters:

resourceItems - Resource items to wrap in a multi file.

urls - External resource URLs to read.

attachmentSearchName - Pattern for the name of attachments to find.

attachmentSources - Attachment sources to find.

Returns:

A multi file referencing the given files.

forResourceItems

public static MultiFile forResourceItems(ResourceItem... items)

Parameters:

items - Resource items to wrap in a multi file.

Returns:

A multi file referencing the given resource items.