Package de.aeb.xnsg.docservice.bf

Class PrintDocumentInstanceResponseDTO

java.lang.Object

de.aeb.xnsg.foundation.bf.AbstractResponseDTO

de.aeb.xnsg.docservice.bf.PrintDocumentInstanceResponseDTO

public class PrintDocumentInstanceResponseDTO
extends AbstractResponseDTO

Field Summary

Fields

Modifier and Type	Field	Description
DocumentInfoDTO	documentInfo	Information about the document to be printed.
OutputSettingsPrinterDTO	effectiveOutputSettings	The expected printer settings in the context known at the current time.
String	printRequestId	The unique ID of the created print request.
String	state	The result state of the document processing: SUCCESS - A print request for the referenced document has been created successfully. DOCUMENT_NOT_FOUND - The referenced document to be printed has not been found. DOCUMENT_LOCKED - the document to be printed is locked by a user or other process. DOCUMENT_EXPIRED - The referenced document to be printed has expired. LOCKED - an associated object (e.g. output settings) is locked by a user or other process. DOCUMENT_CONTENT_PENDING - The creation of the referenced document to be printed has not been completed. PRINTER_NOT_FOUND - the resolved printer in the context is unavailable at the time of the print request.

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

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 - A print request for the referenced document has been created successfully.
• DOCUMENT_NOT_FOUND - The referenced document to be printed has not been found.
• DOCUMENT_LOCKED - the document to be printed is locked by a user or other process.
• DOCUMENT_EXPIRED - The referenced document to be printed has expired.
• LOCKED - an associated object (e.g. output settings) is locked by a user or other process.
• DOCUMENT_CONTENT_PENDING - The creation of the referenced document to be printed has not been completed.
• PRINTER_NOT_FOUND - the resolved printer in the context is unavailable at the time of the print request.

See Also:

• IDocumentServiceBF.STATE_SUCCESS
• IDocumentServiceBF.STATE_DOCUMENT_NOT_FOUND
• IDocumentServiceBF.STATE_DOCUMENT_LOCKED
• IDocumentServiceBF.STATE_DOCUMENT_EXPIRED
• IDocumentServiceBF.STATE_OBJECT_LOCKED
• IDocumentServiceBF.STATE_DOCUMENT_CONTENT_PENDING
• IDocumentServiceBF.STATE_PRINTER_NOT_FOUND

printRequestId

public String printRequestId

The unique ID of the created print request. It is used to retrieve its status by calling IDocumentServiceBF.getPrintRequestState(GetPrintRequestStateRequestDTO)

effectiveOutputSettings

public OutputSettingsPrinterDTO effectiveOutputSettings

The expected printer settings in the context known at the current time.

documentInfo

public DocumentInfoDTO documentInfo

Information about the document to be printed.

Constructor Details

PrintDocumentInstanceResponseDTO

public PrintDocumentInstanceResponseDTO()