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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description List<EAttachmentSource>getAttachmentFilter()intgetConnectionTimeout()intgetReadTimeout()ResourceItemgetResource()default List<ResourceItem>getResources()StringgetSearchFilename()StringgetUrl()default List<String>getUrls() 
 - 
 
- 
- 
Method Detail
- 
getResource
@Nullable ResourceItem getResource()
- Returns:
 - The resource item for the file.
 
 
- 
getResources
default List<ResourceItem> getResources()
- Specified by:
 getResourcesin interfaceIReferencedFileList- Returns:
 - All resource items pointing to the files.
 
 
- 
getUrl
String getUrl()
- Returns:
 null, or the resource path, ifResourceItem.getType()is anEResourceItemType.EXTERNALresource.
 
- 
getUrls
default List<String> getUrls()
- Specified by:
 getUrlsin interfaceIReferencedFileList- Returns:
 - All URLs from which to read data, if a resource item of type 
EResourceItemType.EXTERNALexists. 
 
- 
getAttachmentFilter
List<EAttachmentSource> getAttachmentFilter()
- Specified by:
 getAttachmentFilterin interfaceIReferencedFileList- Returns:
 - Attachment sources to which to restrict the search for attachments, if a resource item of type
 
EResourceItemType.EXTERNALexists. 
 
- 
getConnectionTimeout
int getConnectionTimeout()
- Specified by:
 getConnectionTimeoutin interfaceIReferencedFileList- Returns:
 - a connection time-out for an external resource retrieval
 
 
- 
getReadTimeout
int getReadTimeout()
- Specified by:
 getReadTimeoutin interfaceIReferencedFileList- Returns:
 - a read time-out for an external resource retrieval
 
 
- 
getSearchFilename
String getSearchFilename()
- Specified by:
 getSearchFilenamein interfaceIReferencedFileList- Returns:
 - Pattern for searching for an attachment, if a resource item of type 
EResourceItemType.ATTACHMENT_SEARCHexists.nullor empty when no such resource item exists. 
 
 - 
 
 -