net.dreceiptx.receipt.document

Class DocumentIdentification

java.lang.Object

net.dreceiptx.receipt.document.DocumentIdentification

public class DocumentIdentification
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DocumentIdentification() Creates instance of DocumentIdentification with default values set.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getCreationDateAndTime() Gets and sets the CreationDateAndTime.
java.lang.String	getInstanceIdentifier() Gets the InstanceIdentifier.
java.lang.String	getMultipleType() Gets and sets the MultipleType property.
java.lang.String	getStandard() Gets the Standard.
java.lang.String	getType() Gets and sets the Type.
java.lang.String	getTypeVersion() Gets the TypeVersion.
void	setCreationDateAndTime(java.util.Date creationDateAndTime) Sets the CreationDateAndTime
void	setInstanceIdentifier(java.lang.String instanceIdentifier) Sets the InstanceIdentifier.
void	setMultipleType(java.lang.String multipleType) Sets the MultipleType property
void	setStandard(java.lang.String standard) Sets the Standard.
void	setType(java.lang.String type) Sets the Type.
void	setTypeVersion(java.lang.String typeVersion) Sets the TypeVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentIdentification

public DocumentIdentification()

Creates instance of DocumentIdentification with default values set.

Method Detail

getStandard

public java.lang.String getStandard()

Gets the Standard. The name of the document standard contained in the payload The value of the element Standard MUST be set to the value 'GS1'

Returns:

setStandard

public void setStandard(java.lang.String standard)

Sets the Standard. The name of the document standard contained in the payload The value of the element Standard MUST be set to the value 'com.digitalreceiptexchange.GS1'

Parameters:

standard -

getTypeVersion

public java.lang.String getTypeVersion()

Gets the TypeVersion. Version information of the document included in the payload of SBDH. This is the 'complete' version of the document itself and is different than the HeaderVersion. The value of TypeVersion MUST be set the version number of the root schema of the XML business document contained in the payload of the message. Every com.digitalreceiptexchange.GS1 standard schema has version information in the �xsd:version? attribute of the �xsd:schema? tag of the schema and also in the schema annotation tag. The SBDH specification requires that all documents sent with one header have the same version number. To comply with this requirement; Only business documents belonging to the same BMS publication release and having the same version number MUST be included in the payload if sending more than one document type.

Returns:

setTypeVersion

public void setTypeVersion(java.lang.String typeVersion)

Sets the TypeVersion

Parameters:

typeVersion -

getType

public java.lang.String getType()

Gets and sets the Type. This element identifies the type of the document The value of the �Type? element of �DocumentIdentification? element MUST be set to the name of the XML element that defines the root of the business document. This is the name of the global XML element declared in the root schema for the business document in consideration. Example; order, invoice, debitCreditAdvice,

Returns:

setType

public void setType(java.lang.String type)

Sets the Type.

Parameters:

type -

getInstanceIdentifier

public java.lang.String getInstanceIdentifier()

Gets the InstanceIdentifier. Description which contains reference information which uniquely identifies this instance of the Standard Business Document (SBD) between the Sender and the Receiver. This identifier identifies this document as being distinct from others. Example: MSG-1645000099

Returns:

setInstanceIdentifier

public void setInstanceIdentifier(java.lang.String instanceIdentifier)

Sets the InstanceIdentifier.

Parameters:

instanceIdentifier -

getMultipleType

public java.lang.String getMultipleType()

Gets and sets the MultipleType property. Flag to indicate that there is more than one type of business document in the payload of the SBDH. The value of the MultiType element of DocumentIdentification element MUST be set false as the com.digitalreceiptexchange.GS1 XML design allows only one type of business documents to be sent within one message. TODO: Raised #6 on this as i think it should be a boolean

Returns:

setMultipleType

public void setMultipleType(java.lang.String multipleType)

Sets the MultipleType property

Parameters:

multipleType -

getCreationDateAndTime

public java.util.Date getCreationDateAndTime()

Gets and sets the CreationDateAndTime. Date and time of the SBDH document creation. The value of the �CreationDateAndTime? element MUST be set to the date and time when the document originating application or the parser created the document. This value will typically be populated by the trading partner and will typically differ from the time stamping of the message by the communications software.

Returns:

setCreationDateAndTime

public void setCreationDateAndTime(java.util.Date creationDateAndTime)

Sets the CreationDateAndTime

Parameters:

creationDateAndTime -