Package de.aeb.xnsg.docservice.bf

Class PrepareDocumentInstanceResponseDTO

java.lang.Object

de.aeb.xnsg.foundation.bf.AbstractResponseDTO

de.aeb.xnsg.docservice.bf.PrepareDocumentInstanceResponseDTO

public class PrepareDocumentInstanceResponseDTO
extends AbstractResponseDTO

Contains just the documentId of the staged document. The document contents are created asynchronously

Field Summary

Fields

Modifier and Type	Field	Description
String	documentId	The unique documentId for a stored document.
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_VERSION_MISMATCH - the document template of the document type does not have the desired external tag. REFERENCE_OBJECT_NOT_FOUND - the 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
PrepareDocumentInstanceResponseDTO()

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_VERSION_MISMATCH - the document template of the document type does not have the desired external tag.
• REFERENCE_OBJECT_NOT_FOUND - the reference object has not been found. It may not exist or the user has no right to read it.
• DOCUMENT_INSTANCE_CREATION_ERROR - the requested document instance could not be created.
• DOCUMENT_CONTENT_PENDING - the asynchronous creation of requested content has not been completed and document cannot be updated yet.
• 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.
• OBJECT_LOCKED - an object to process is locked by a user or other process and cannot be updated.

See Also:

• IDocumentServiceBF.STATE_SUCCESS
• IDocumentServiceBF.STATE_TEMPLATE_MISSING
• IDocumentServiceBF.STATE_TEMPLATE_VERSION_MISMATCH
• IDocumentServiceBF.STATE_REFERENCE_OBJECT_NOT_FOUND
• IDocumentServiceBF.STATE_DOCUMENT_INSTANCE_CREATION_ERROR
• IDocumentServiceBF.STATE_DOCUMENT_CONTENT_PENDING
• IDocumentServiceBF.STATE_DOCUMENT_LOCKED
• IDocumentServiceBF.STATE_DOCUMENT_EXPIRED
• IDocumentServiceBF.STATE_OBJECT_LOCKED

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

PrepareDocumentInstanceResponseDTO

public PrepareDocumentInstanceResponseDTO()