Package de.aeb.xnsg.docservice.bf

Class DeleteDocumentInstanceResponseDTO

java.lang.Object

de.aeb.xnsg.foundation.bf.AbstractResponseDTO

de.aeb.xnsg.docservice.bf.DeleteDocumentInstanceResponseDTO

public class DeleteDocumentInstanceResponseDTO
extends AbstractResponseDTO

Contains the result of the deletion.

Field Summary

Fields

Modifier and Type	Field	Description
String	documentId	ID of the deleted document instance.
String	state	The result state of the deletion: SUCCESS - document has been deleted 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
DeleteDocumentInstanceResponseDTO()

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 deletion:

• SUCCESS - document has been deleted
• 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 deleted has not been found. It may not exist or the user has no right to delete it.
• DOCUMENT_LOCKED - the document to be deleted is locked by a user or other process and cannot be deleted.
• DOCUMENT_CONTENT_PENDING - the asynchronous creation of requested content has not been completed yet. The deletion can be enforced by enabling ignorePendingContent in the request.

See Also:

• IDocumentServiceBF.STATE_SUCCESS
• IDocumentServiceBF.STATE_REFERENCE_OBJECT_NOT_FOUND
• IDocumentServiceBF.STATE_DOCUMENT_NOT_FOUND
• IDocumentServiceBF.STATE_DOCUMENT_LOCKED
• IDocumentServiceBF.STATE_DOCUMENT_CONTENT_PENDING

documentId

public String documentId

ID of the deleted document instance.

Constructor Details

DeleteDocumentInstanceResponseDTO

public DeleteDocumentInstanceResponseDTO()