Interface IRequestUploadData
-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
DefaultRequestUploadData
public interface IRequestUploadData extends Serializable
Data for adding an upload request to a form record message.- Since:
- 8.2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Set<String>
acceptedUploadTypes()
Types of files that are accepted for upload.EUploadRequestFileMergeMode
fileMergeMode()
String
formFieldName()
Name of an upload form field associated with the upload request.Long
maxNumberOfFiles()
Maximum number of files that may be uploaded.long
minNumberOfFiles()
Minimum number of files that must be uploaded.String
name()
Optional.Long
repetitionId()
Optional.Long
uploadSizeLimit()
Maximum size of the upload in bytes.
-
-
-
Method Detail
-
acceptedUploadTypes
Set<String> acceptedUploadTypes()
Types of files that are accepted for upload. May be null or empty if all types are accepted.- Returns:
- Types of files that are accepted for upload.
-
fileMergeMode
EUploadRequestFileMergeMode fileMergeMode()
-
formFieldName
String formFieldName()
Name of an upload form field associated with the upload request. May be null or empty if the upload request is not associated with a form field.- Returns:
- Name of the upload form field.
-
maxNumberOfFiles
Long maxNumberOfFiles()
Maximum number of files that may be uploaded. May be null if the number of files is not limited.- Returns:
- Maximum number of files that may be uploaded.
-
minNumberOfFiles
long minNumberOfFiles()
Minimum number of files that must be uploaded.- Returns:
- Minimum number of files that must be uploaded.
-
name
String name()
Optional. Name of the upload request that may be displayed to the user.- Returns:
- Name of the upload request.
-
repetitionId
Long repetitionId()
Optional. ID of the repetition of the upload request. May be null if the upload request is not repeated. Note that ID is not the ordinal index of the repetition, but a unique identifier. An ordinal index starts at 0 is continuous (0,1,2,3,4,...), while an ID may be any unique value.- Returns:
- ID of the repetition of the upload request.
-
uploadSizeLimit
Long uploadSizeLimit()
Maximum size of the upload in bytes. May be null if the size is not limited.- Returns:
- Maximum size of the upload in bytes.
-
-