Package de.aeb.xnsg.docservice.bf

Class CreateDocumentRequestDTO

java.lang.Object

de.aeb.xnsg.foundation.bf.AbstractRequestDTO

de.aeb.xnsg.docservice.bf.CreateDocumentRequestDTO

Direct Known Subclasses:

PrepareDocumentRequestDTO

public class CreateDocumentRequestDTO
extends AbstractRequestDTO

Parameters for a single document creation.

Field Summary

Fields

Modifier and Type	Field	Description
DocumentProcessingOptionsDTO	documentProcessingOptions	Document processing options (format, page settings, etc.).
DocumentStorageOptionsDTO	documentStorageOptions	Document storage options (reference-id, name, keys, additional formats etc.).
JobProcessingOptionsDTO	jobProcessingOptions	Job processing options (timeout, tracing, etc.)
jakarta.activation.DataHandler	jsonData	The raw JSON data to fill in the template with.
StagedDocumentOptionsDTO	stagedDocumentOptions	Options to define that the created document has to be stored in the engine for a certain amount of time.
DocumentTemplateReferenceDTO	template	The template to be used.
Boolean	translateDataRequired	If set to true the values of document data (xmlData/jsonData) will be translated.
jakarta.activation.DataHandler	xmlData	The raw XML data to fill in the template with.

Fields inherited from class de.aeb.xnsg.foundation.bf.AbstractRequestDTO

clientIdentCode, clientSystemId, resultLanguageIsoCodes, userName

Constructor Summary

Constructors

Constructor	Description
CreateDocumentRequestDTO()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

template

public DocumentTemplateReferenceDTO template

The template to be used.

stagedDocumentOptions

public StagedDocumentOptionsDTO stagedDocumentOptions

Options to define that the created document has to be stored in the engine for a certain amount of time.

xmlData

public jakarta.activation.DataHandler xmlData

The raw XML data to fill in the template with.

jsonData

public jakarta.activation.DataHandler jsonData

The raw JSON data to fill in the template with. Will only be used if xmlData is not filled.

translateDataRequired

public Boolean translateDataRequired

If set to true the values of document data (xmlData/jsonData) will be translated. In that case it is necessary to set the DocumentProcessingOptionsDTO.documentLocale, too.
How the placeholder in the document data are translated depends on the document processor and the referenced document template.

documentProcessingOptions

public DocumentProcessingOptionsDTO documentProcessingOptions

Document processing options (format, page settings, etc.).

jobProcessingOptions

public JobProcessingOptionsDTO jobProcessingOptions

Job processing options (timeout, tracing, etc.)

documentStorageOptions

public DocumentStorageOptionsDTO documentStorageOptions

Document storage options (reference-id, name, keys, additional formats etc.).

Constructor Details

CreateDocumentRequestDTO

public CreateDocumentRequestDTO()