Package de.xima.fc.form_record.api.message

Class SendMessageUploadRequestData

java.lang.Object

de.xima.fc.form_record.api.message.SendMessageUploadRequestData

All Implemented Interfaces:

ISendMessageUploadRequestData, Serializable

public class SendMessageUploadRequestData
extends Object
implements ISendMessageUploadRequestData

Builder for ISendMessageUploadRequestData

Since:

8.4.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
static ISendMessageUploadRequestData	formField(String formFieldName, EUploadRequestFileMergeMode fileMergeMode)
static ISendMessageUploadRequestData	formFieldRepetition(String formFieldName, EUploadRequestFileMergeMode fileMergeMode, long repetitionId)
static ISendMessageUploadRequestData	general()
EUploadRequestFileMergeMode	getFileMergeMode()	How to handle existing files when the user uploads files to fulfill the upload request.
String	getFormFieldName()	Name of an upload form field associated with the upload request.
Long	getRepetitionId()	Optional.

Methods inherited from class java.lang.Object

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

Method Detail

getFileMergeMode

public EUploadRequestFileMergeMode getFileMergeMode()

Description copied from interface: ISendMessageUploadRequestData

How to handle existing files when the user uploads files to fulfill the upload request.

Specified by:

getFileMergeMode in interface ISendMessageUploadRequestData

Returns:

How to handle existing files when the upload requests is fulfilled.

getFormFieldName

public String getFormFieldName()

Description copied from interface: ISendMessageUploadRequestData

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.

Specified by:

getFormFieldName in interface ISendMessageUploadRequestData

Returns:

Name of the upload form field.

getRepetitionId

public Long getRepetitionId()

Description copied from interface: ISendMessageUploadRequestData

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.

Specified by:

getRepetitionId in interface ISendMessageUploadRequestData

Returns:

ID of the repetition of the upload request.

general

public static ISendMessageUploadRequestData general()

formField

public static ISendMessageUploadRequestData formField(String formFieldName,
                                                      EUploadRequestFileMergeMode fileMergeMode)

formFieldRepetition

public static ISendMessageUploadRequestData formFieldRepetition(String formFieldName,
                                                                EUploadRequestFileMergeMode fileMergeMode,
                                                                long repetitionId)