Class DefaultFulfillRequestedUploadRequest

java.lang.Object

de.xima.fc.common.form_record.chat.DefaultFulfillRequestedUploadRequest

All Implemented Interfaces:

IFulfillRequestedUploadRequest, Serializable

public final class DefaultFulfillRequestedUploadRequest
extends Object
implements IFulfillRequestedUploadRequest

Simple POJO implementation of IFulfillRequestedUploadRequest with a builder.

Since:

8.2.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultFulfillRequestedUploadRequest.BaseBuilder<Request, Self extends DefaultFulfillRequestedUploadRequest.BaseBuilder<Request,Self>>	Builder for the data needed to fulfill a pending upload request.
static final class	DefaultFulfillRequestedUploadRequest.Builder	Builder for an IFulfillRequestedUploadRequest.

Method Summary

Modifier and Type	Method	Description
EAttachmentSource	attachmentSource()	Applies only when the upload request does not reference an upload element.
UUID	enforceChatUuid()	When given, enforces that the IFulfillRequestedUploadRequest.uploadRequestUuid() matches the given chat UUID, i.e. that the chat contains the upload request.
boolean	enforceExplicitContentType()	When true, enforces that the files have an explicit content type.
boolean	enforceMatchingUser()	When true, enforces that the user fulfilling the request matches one of members of the chat containing the message with the upload request.
UUID	enforceMessageUuid()	When given, enforces that the IFulfillRequestedUploadRequest.uploadRequestUuid() matches the given message UUID, i.e. that the message contains the upload request.
List<ISerializableFile>	files()	The files to use for fulfilling the upload request.
static DefaultFulfillRequestedUploadRequest.Builder	fulfillUploadRequestBuilder(FormRecordMessageUploadRequest uploadRequest)	Creates a new builder for the data need to fulfill a pending upload request.
static DefaultFulfillRequestedUploadRequest.Builder	fulfillUploadRequestBuilder(UUID uploadRequestUuid)	Creates a new builder for the data need to fulfill a pending upload request.
boolean	initializeResponse()	When true, initializes all fields in the response entities (i.e. ensures referenced child entities are loaded from the database).
Locale	locale()	The locale to use for the response.
boolean	makeFilesAccessibleToEndUser()	Whether to make the newly created attachments accessible to the end user.
IUser	oathKeeper()	The user who provided the upload to fulfill the request.
UUID	uploadRequestUuid()	The UUID of a pending upload request.

Methods inherited from class Object

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

Method Details

attachmentSource

public EAttachmentSource attachmentSource()

Description copied from interface: IFulfillRequestedUploadRequest

Applies only when the upload request does not reference an upload element. The source of the attachments to create. Defaults to UNKNOWN. Note that when the upload request references an upload element, the source is always set to FORM_UPLOAD.

Specified by:

attachmentSource in interface IFulfillRequestedUploadRequest

Returns:

The source of the attachments to create.

enforceChatUuid

public UUID enforceChatUuid()

Description copied from interface: IFulfillRequestedUploadRequest

When given, enforces that the IFulfillRequestedUploadRequest.uploadRequestUuid() matches the given chat UUID, i.e. that the chat contains the upload request.

Specified by:

enforceChatUuid in interface IFulfillRequestedUploadRequest

Returns:

The UUID of the message to enforce.

enforceExplicitContentType

public boolean enforceExplicitContentType()

Description copied from interface: IFulfillRequestedUploadRequest

When true, enforces that the files have an explicit content type. Defaults to false.

Specified by:

enforceExplicitContentType in interface IFulfillRequestedUploadRequest

Returns:

Whether to enforce that the files have an explicit content type.

enforceMatchingUser

public boolean enforceMatchingUser()

Description copied from interface: IFulfillRequestedUploadRequest

When true, enforces that the user fulfilling the request matches one of members of the chat containing the message with the upload request. Defaults to false.

Specified by:

enforceMatchingUser in interface IFulfillRequestedUploadRequest

Returns:

When true, enforces that the user fulfilling the request matches one of the chat members.

enforceMessageUuid

public UUID enforceMessageUuid()

Description copied from interface: IFulfillRequestedUploadRequest

When given, enforces that the IFulfillRequestedUploadRequest.uploadRequestUuid() matches the given message UUID, i.e. that the message contains the upload request.

Specified by:

enforceMessageUuid in interface IFulfillRequestedUploadRequest

Returns:

The UUID of the message to enforce.

files

public List<ISerializableFile> files()

Description copied from interface: IFulfillRequestedUploadRequest

The files to use for fulfilling the upload request. When the files do not have an explicit content type, attempts to guess the type, unless an explicit content type is enforced.

Specified by:

files in interface IFulfillRequestedUploadRequest

Returns:

The files to use for fulfilling the upload request.

initializeResponse

public boolean initializeResponse()

Description copied from interface: IFulfillRequestedUploadRequest

When true, initializes all fields in the response entities (i.e. ensures referenced child entities are loaded from the database). Defaults to false.

Specified by:

initializeResponse in interface IFulfillRequestedUploadRequest

Returns:

When true, initializes all fields in the response entities.

makeFilesAccessibleToEndUser

public boolean makeFilesAccessibleToEndUser()

Description copied from interface: IFulfillRequestedUploadRequest

Whether to make the newly created attachments accessible to the end user. Defaults to false.

Specified by:

makeFilesAccessibleToEndUser in interface IFulfillRequestedUploadRequest

Returns:

Whether to make the newly created attachments accessible to the end user.

oathKeeper

public IUser oathKeeper()

Description copied from interface: IFulfillRequestedUploadRequest

The user who provided the upload to fulfill the request. Uses an (unspecified) default when not given.

Specified by:

oathKeeper in interface IFulfillRequestedUploadRequest

Returns:

The user who provided the upload to fulfill the request.

uploadRequestUuid

public UUID uploadRequestUuid()

Description copied from interface: IFulfillRequestedUploadRequest

The UUID of a pending upload request. Since the UUID must be globally unique within the system, this is sufficient to identify the request.

Specified by:

uploadRequestUuid in interface IFulfillRequestedUploadRequest

Returns:

The UUID of the upload request.

locale

public Locale locale()

Description copied from interface: IFulfillRequestedUploadRequest

The locale to use for the response.

Specified by:

locale in interface IFulfillRequestedUploadRequest

Returns:

The locale to use for the response.

fulfillUploadRequestBuilder

public static DefaultFulfillRequestedUploadRequest.Builder fulfillUploadRequestBuilder(UUID uploadRequestUuid)

Creates a new builder for the data need to fulfill a pending upload request.

Parameters:

uploadRequestUuid - The UUID of the pending upload request.

Returns:

A new builder for the data need to fulfill a pending upload request.

fulfillUploadRequestBuilder

public static DefaultFulfillRequestedUploadRequest.Builder fulfillUploadRequestBuilder(FormRecordMessageUploadRequest uploadRequest)

Creates a new builder for the data need to fulfill a pending upload request.

Parameters:

uploadRequest - The pending upload request.

Returns:

A new builder for the data need to fulfill a pending upload request.