Package de.aeb.xnsg.dl.bf

Class DLDocumentOutputModeDTO

java.lang.Object

de.aeb.xnsg.dl.bf.DLDocumentOutputModeDTO

public class DLDocumentOutputModeDTO
extends Object

DTO specifying the output mode for documents.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOCUMENT_OUTPUT_MODE_NONE	Constant for the document output mode 'none'.
static final String	DOCUMENT_OUTPUT_MODE_PRINT	Constant for the document output mode 'print'.
static final String	DOCUMENT_OUTPUT_MODE_RETURN	Constant for the document output mode 'return'.
Boolean	includeContent	Only relevant for mode RETURN.
Boolean	includeDocumentId	Only relevant for mode RETURN.
String	mode	The output mode for the documents.

Constructor Summary

Constructors

Constructor	Description
DLDocumentOutputModeDTO()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DOCUMENT_OUTPUT_MODE_PRINT

public static final String DOCUMENT_OUTPUT_MODE_PRINT

Constant for the document output mode 'print'.

See Also:

• Constant Field Values

DOCUMENT_OUTPUT_MODE_RETURN

public static final String DOCUMENT_OUTPUT_MODE_RETURN

Constant for the document output mode 'return'. Requires, that the process mode is 'EXTENDED'.

See Also:

• Constant Field Values

DOCUMENT_OUTPUT_MODE_NONE

public static final String DOCUMENT_OUTPUT_MODE_NONE

Constant for the document output mode 'none'.

See Also:

• Constant Field Values

mode

public String mode

The output mode for the documents. Valid values are:

PRINT The documents will be automatically printed on the client system. A print job agent has to be installed and activated there.

RETURN The print data of the documents will be returned to the client system to be printed there. This is also the default when mode is left empty.

NONE No documents will be returned or printed.

length=15

includeDocumentId

public Boolean includeDocumentId

Only relevant for mode RETURN. Controls, if the document ID (field DLDocumentDTO.documentId) should be filled. Defaults to "false".

includeContent

public Boolean includeContent

Only relevant for mode RETURN. Controls, if the document content (field DLDocumentDTO.content) should be filled. Use this setting if you only need reference data of the documents but not the actual content. Defaults to "true".

Constructor Details

DLDocumentOutputModeDTO

public DLDocumentOutputModeDTO()