Package de.xima.fc.interfaces.workflow.execution

Interface ISingleFileProviding

All Superinterfaces:

IReferencedFileList

All Known Implementing Classes:

SingleFile

public interface ISingleFileProviding
extends IReferencedFileList

Interface for a POJO view model class that describes a single file that can be selected by the user.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
List<EAttachmentSource>	getAttachmentFilter()
int	getConnectionTimeout()
int	getReadTimeout()
ResourceItem	getResource()
default List<ResourceItem>	getResources()
String	getSearchFilename()
String	getUrl()
default List<String>	getUrls()

Method Details

getResource

@Nullable
ResourceItem getResource()

Returns:

The resource item for the file.

getResources

default List<ResourceItem> getResources()

Specified by:

getResources in interface IReferencedFileList

Returns:

All resource items pointing to the files.

getUrl

String getUrl()

Returns:

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

getUrls

default List<String> getUrls()

Specified by:

getUrls in interface IReferencedFileList

Returns:

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

getAttachmentFilter

List<EAttachmentSource> getAttachmentFilter()

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

int getConnectionTimeout()

Specified by:

getConnectionTimeout in interface IReferencedFileList

Returns:

a connection time-out for an external resource retrieval

getReadTimeout

int getReadTimeout()

Specified by:

getReadTimeout in interface IReferencedFileList

Returns:

a read time-out for an external resource retrieval

getSearchFilename

String getSearchFilename()

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.