Package de.aeb.xnsg.docservice.bf

Class DocumentReferenceDTO

java.lang.Object

de.aeb.xnsg.docservice.bf.DocumentReferenceDTO

public class DocumentReferenceDTO
extends Object

A Document Service document references an external object that is not stored in the engine. To create a document the caller must identify the document by defining the document type and reference object (type and number). The DocumentReferenceDTO is necessary because neither document type nor reference object are part of the engine. These information are also used to query for documents (e.g. collect all documents for a specific referenced external object like "CONS 4711").

Field Summary

Fields

Modifier and Type	Field	Description
String	documentType	Brief name of the referenced (external) document, e.g.
String	referenceNumber	Identification of the referenced (external) object (e.g. a reference number).
String	referenceType	Type of the referenced (external) object, e.g.

Constructor Summary

Constructors

Constructor	Description
DocumentReferenceDTO()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

documentType

public String documentType

Brief name of the referenced (external) document, e.g. "INVOICE", "PACKING LIST" etc.

referenceType

public String referenceType

Type of the referenced (external) object, e.g. "CONSIGNEMENT", "PACKAGE", "CUSTOMER" etc.

referenceNumber

public String referenceNumber

Identification of the referenced (external) object (e.g. a reference number). This identification must be unique within the type of the referenced (external) object.

Constructor Details

DocumentReferenceDTO

public DocumentReferenceDTO()