Package de.aeb.xnsg.docservice.bf

Class GetDocumentInstanceResponseDTO

java.lang.Object

de.aeb.xnsg.foundation.bf.AbstractResponseDTO

de.aeb.xnsg.docservice.bf.GetDocumentInstanceResponseDTO

public class GetDocumentInstanceResponseDTO
extends AbstractResponseDTO

Contains the document content of the requested document and its DocumentInstanceInfoDTOs.

Field Summary

Fields

Modifier and Type	Field	Description
jakarta.activation.DataHandler	documentContent	The content of the result document file as stream/byte array.
DocumentInstanceInfoDTO	documentInfo	Information about the document and other contents in the document.
Boolean	fromArchive	true if the document and its contents was fetched from the archive.
String	state	The result state of fetching the document: SUCCESS - the request was successful. REFERENCE_OBJECT_NOT_FOUND - the given reference object has not been found.

Fields inherited from class de.aeb.xnsg.foundation.bf.AbstractResponseDTO

EMPTY_MANDATORY_FIELD, hasErrors, hasOnlyRetryableErrors, hasWarnings, I18N_WARNING, INTERNAL_SERVER_ERROR, INVALID_DATA_ERROR, INVALID_DATA_WARNING, LOCK_ERROR, messages

Constructor Summary

Constructors

Constructor	Description
GetDocumentInstanceResponseDTO()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

state

public String state

The result state of fetching the document:

• SUCCESS - the request was successful.
• REFERENCE_OBJECT_NOT_FOUND - the given reference object has not been found. It may not exist or the user has no right to read it.
• DOCUMENT_NOT_FOUND - the document to be fetched has not been found. It may not exist or the user has no right to read it.
• DOCUMENT_EXPIRED - the document to be fetched has expired.
• DOCUMENT_CONTENT_MISSING - the requested content has not been found.
• DOCUMENT_CONTENT_PENDING - the asynchronous creation of requested content has not yet been completed yet.
• DOCUMENT_CONTENT_CREATION_ERROR - the asynchronous creation of requested content failed.
• MULTIPLE_DOCUMENT_CONTENTS_FOUND - multiple contents have been found. It is necessary to describe the desired content in more detail with the contentVariant in the request.

See Also:

• IDocumentServiceBF.STATE_SUCCESS
• IDocumentServiceBF.STATE_REFERENCE_OBJECT_NOT_FOUND
• IDocumentServiceBF.STATE_DOCUMENT_NOT_FOUND
• IDocumentServiceBF.STATE_DOCUMENT_EXPIRED
• IDocumentServiceBF.STATE_DOCUMENT_CONTENT_MISSING
• IDocumentServiceBF.STATE_DOCUMENT_CONTENT_PENDING
• IDocumentServiceBF.STATE_DOCUMENT_CONTENT_CREATION_ERROR
• IDocumentServiceBF.STATE_MULTIPLE_DOCUMENT_CONTENTS_FOUND

documentContent

public jakarta.activation.DataHandler documentContent

The content of the result document file as stream/byte array. The content depends on the applied processor and the processing options and parameters (format etc.).

documentInfo

public DocumentInstanceInfoDTO documentInfo

Information about the document and other contents in the document.

fromArchive

public Boolean fromArchive

true if the document and its contents was fetched from the archive.

Constructor Details

GetDocumentInstanceResponseDTO

public GetDocumentInstanceResponseDTO()