Package de.aeb.xnsg.docservice.bf

Class DocumentTemplateReferenceDTO

java.lang.Object

de.aeb.xnsg.docservice.bf.DocumentTemplateReferenceDTO

public class DocumentTemplateReferenceDTO
extends Object

Represents a reference to a document templates which is known to the document service. The template is identified by its name (file name incl. extension) and optionally by a version and/or revision.

Field Summary

Fields

Modifier and Type	Field	Description
String	externalTag	The desired external tag of the document template.
String	filename	The relative file name of the document template in the file system (without path).
String	processor	The document processor tag.

Constructor Summary

Constructors

Constructor	Description
DocumentTemplateReferenceDTO()
DocumentTemplateReferenceDTO(String processor)

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

processor

public String processor

The document processor tag. The tag decides, which processor takes care of the document.

If there is no processor registered and supported for the tag, a DocumentServiceTaskException is thrown.

filename

public String filename

The relative file name of the document template in the file system (without path). This name, together with the version, uniquely identifies a template resource.

externalTag

public String externalTag

The desired external tag of the document template. If filled, requests will assert that the document template is tagged with this value.

Constructor Details

DocumentTemplateReferenceDTO

public DocumentTemplateReferenceDTO()

DocumentTemplateReferenceDTO

public DocumentTemplateReferenceDTO(String processor)

Parameters:

processor - required processor tag

See Also:

• IDocumentServiceBF.getSupportedProcessors()