Package de.aeb.xnsg.docservice.bf

Class PutDocumentResponseDTO

java.lang.Object

de.aeb.xnsg.foundation.bf.AbstractResponseDTO

de.aeb.xnsg.docservice.bf.PutDocumentResponseDTO

public class PutDocumentResponseDTO
extends AbstractResponseDTO

Contains the documentId of the external document if the upload was successful.

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

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.
• 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_DOCUMENT_NOT_FOUND
• IDocumentServiceBF.STATE_DOCUMENT_LOCKED
• IDocumentServiceBF.STATE_DOCUMENT_EXPIRED

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

PutDocumentResponseDTO

public PutDocumentResponseDTO()