Package de.aeb.xnsg.docservice.bf

Class CreateDocumentResponseDTO

java.lang.Object

de.aeb.xnsg.foundation.bf.AbstractResponseDTO

de.aeb.xnsg.docservice.bf.CreateDocumentResponseDTO

public class CreateDocumentResponseDTO
extends AbstractResponseDTO

Contains the created document and accompanying information.

Field Summary

Fields

Modifier and Type	Field	Description
jakarta.activation.DataHandler	documentContent	The content of the result document file as stream/byte array.
String	documentId	The unique documentId for a stored document.
PageNumberMappingDTO[]	pageNumberMappings	Resulting template page name to page range mappings.
DocumentProcessingInfoDTO[]	processingInfos	The processing traces and problems as array of structured information (type, description, element path).
String	retentionTimestamp	Date to which this document is at least stored in the document store.
String	state	The result state of the document processing: SUCCESS - everything is fine (the processingInfos can contain traces) TEMPLATE_MISSING - the document template is unknown to the server, retry when the template is available TEMPLATE_TEMPLATE_VERSION_MISMATCH - the document template does not have the desired external tag PROCESSING_PROBLEMS - there were some problems during the processing, see processingInfos for more information DOCUMENT_NOT_FOUND - the referenced document to update has not been found DOCUMENT_LOCKED - the document to be updated is locked by a user or other process and cannot be updated. DOCUMENT_EXPIRED - the document to be updated has expired.

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
CreateDocumentResponseDTO()

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 the document processing:

• SUCCESS - everything is fine (the processingInfos can contain traces)
• TEMPLATE_MISSING - the document template is unknown to the server, retry when the template is available
• TEMPLATE_TEMPLATE_VERSION_MISMATCH - the document template does not have the desired external tag
• PROCESSING_PROBLEMS - there were some problems during the processing, see processingInfos for more information
• DOCUMENT_NOT_FOUND - the referenced document to update has not been found
• DOCUMENT_LOCKED - the document to be updated is locked by a user or other process and cannot be updated.
• DOCUMENT_EXPIRED - the document to be updated has expired.

See Also:

• IDocumentServiceBF.STATE_SUCCESS
• IDocumentServiceBF.STATE_TEMPLATE_MISSING
• IDocumentServiceBF.STATE_TEMPLATE_VERSION_MISMATCH
• IDocumentServiceBF.STATE_PROCESSING_PROBLEMS
• IDocumentServiceBF.STATE_DOCUMENT_NOT_FOUND
• IDocumentServiceBF.STATE_DOCUMENT_LOCKED
• IDocumentServiceBF.STATE_DOCUMENT_EXPIRED

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.).

pageNumberMappings

public PageNumberMappingDTO[] pageNumberMappings

Resulting template page name to page range mappings.

processingInfos

public DocumentProcessingInfoDTO[] processingInfos

The processing traces and problems as array of structured information (type, description, element path).

documentId

public String documentId

The unique documentId for a stored document. It is used to retrieve the document again at a later time.

retentionTimestamp

public String retentionTimestamp

Date to which this document is at least stored in the document store. The format of this value is YYYY-MM-DD HH:MM:SS (in UTC time).

Constructor Details

CreateDocumentResponseDTO

public CreateDocumentResponseDTO()