com.helger.peppol.sbdh

Class PeppolSBDHDocument

java.lang.Object

com.helger.peppol.sbdh.PeppolSBDHDocument

@NotThreadSafe
public class PeppolSBDHDocument
extends Object

This class contains all the PEPPOL data per SBDH document in a syntax neutral way.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
PeppolSBDHDocument() Deprecated. Use the version with an explicit identifier factory.
PeppolSBDHDocument(com.helger.peppol.identifier.factory.IIdentifierFactory aIdentifierFactory) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	areAllFieldsSet()
static PeppolSBDHDocument	create(Element aBusinessMessage) Deprecated.
static PeppolSBDHDocument	create(Element aBusinessMessage, com.helger.peppol.identifier.factory.IIdentifierFactory aIdentifierFactory) Create a new PeppolSBDHDocument object for a business message.
boolean	equals(Object o)
Element	getBusinessMessage() Get the contained business message.
LocalDateTime	getCreationDateAndTime() The date and time for when this envelope was created.
com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier	getDocumentTypeAsIdentifier()
String	getDocumentTypeScheme()
String	getDocumentTypeValue()
String	getInstanceIdentifier() An informative unique ID created by the issuer of the envelope.
com.helger.peppol.identifier.generic.process.IProcessIdentifier	getProcessAsIdentifier()
String	getProcessScheme()
String	getProcessValue()
com.helger.peppol.identifier.generic.participant.IParticipantIdentifier	getReceiverAsIdentifier()
String	getReceiverScheme()
String	getReceiverValue()
com.helger.peppol.identifier.generic.participant.IParticipantIdentifier	getSenderAsIdentifier()
String	getSenderScheme()
String	getSenderValue()
String	getStandard() The standard of the enveloped business message, normally described by use of the XML namespace of the business message root element (such as urn:oasis:names:specification:ubl:schema:xsd:Order-2).
String	getType() Message type - mandatory in SBDH.
String	getTypeVersion() The version number of the enveloped business message (such as the value "2.1" for OASIS UBL 2.1 or "2.0" for OASIS UBL 2.0).
boolean	hasBusinessMessage() Check if a business message is present without having the need to explicitly call getBusinessMessage() which returns a cloned node and is therefore an expensive operation.
int	hashCode()
PeppolSBDHDocument	setBusinessMessage(Element aBusinessMessage) Set the main business message that should be transmitted together with the SBDH.
PeppolSBDHDocument	setDocumentIdentification(String sStandard, String sTypeVersion, String sType, String sInstanceIdentifier, LocalDateTime aCreationDateAndTime) Set the content of the fields that are mapped to StandardBusinessDocumentHeader/DocumentIdentification.
PeppolSBDHDocument	setDocumentType(String sScheme, String sValue) Set the document type identifier.
PeppolSBDHDocument	setDocumentTypeWithDefaultScheme(String sValue) Set the document type identifier using the default identifier scheme/authority PeppolIdentifierHelper.DEFAULT_DOCUMENT_TYPE_SCHEME .
PeppolSBDHDocument	setProcess(String sScheme, String sValue) Set the process identifier.
PeppolSBDHDocument	setProcessWithDefaultScheme(String sValue) Set the document type identifier using the default identifier scheme/authority PeppolIdentifierHelper.DEFAULT_PROCESS_SCHEME.
PeppolSBDHDocument	setReceiver(String sScheme, String sValue) Set the receiver identifier.
PeppolSBDHDocument	setReceiverWithDefaultScheme(String sValue) Set the receiver identifier value using the default identifier scheme/authority PeppolIdentifierHelper.DEFAULT_PARTICIPANT_SCHEME.
PeppolSBDHDocument	setSender(String sScheme, String sValue) Set the sender identifier.
PeppolSBDHDocument	setSenderWithDefaultScheme(String sValue) Set the sender identifier value using the default identifier scheme/authority PeppolIdentifierHelper.DEFAULT_PARTICIPANT_SCHEME.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PeppolSBDHDocument

@Deprecated
public PeppolSBDHDocument()

Deprecated. Use the version with an explicit identifier factory.

Default constructor.

PeppolSBDHDocument

public PeppolSBDHDocument(@Nonnull
                          com.helger.peppol.identifier.factory.IIdentifierFactory aIdentifierFactory)

Constructor

Parameters:

aIdentifierFactory - Identifier factory to be used. May not be null.

Method Detail

setSender

@Nonnull
public PeppolSBDHDocument setSender(@Nonnull @Nonempty
                                              String sScheme,
                                              @Nonnull @Nonempty
                                              String sValue)

Set the sender identifier.

Parameters:

sScheme - The PEPPOL identifier scheme. This is usually always PeppolIdentifierHelper.DEFAULT_PARTICIPANT_SCHEME. May neither be null nor empty. This field is mapped to StandardBusinessDocumentHeader/Sender/Identifier/@Authority .

sValue - The sender identifier value. May neither be null nor empty. This field is mapped to StandardBusinessDocumentHeader/Sender/Identifier/.

Returns:

this

setSenderWithDefaultScheme

@Nonnull
public PeppolSBDHDocument setSenderWithDefaultScheme(@Nonnull @Nonempty
                                                               String sValue)

Set the sender identifier value using the default identifier scheme/authority PeppolIdentifierHelper.DEFAULT_PARTICIPANT_SCHEME.

Parameters:

sValue - The sender identifier value. May neither be null nor empty. This field is mapped to StandardBusinessDocumentHeader/Sender/Identifier/.

Returns:

this

getSenderScheme

@Nullable
public String getSenderScheme()

Returns:

The sender identifier scheme. May be null if not initialized. This field is mapped to StandardBusinessDocumentHeader/Sender/Identifier/@Authority .

getSenderValue

@Nullable
public String getSenderValue()

Returns:

The sender identifier value. May be null if not initialized. This field is mapped to StandardBusinessDocumentHeader/Sender/Identifier/.

getSenderAsIdentifier

@Nullable
public com.helger.peppol.identifier.generic.participant.IParticipantIdentifier getSenderAsIdentifier()

Returns:

The sender identifier as a participant identifier or null if certain information are missing or are invalid.

setReceiver

@Nonnull
public PeppolSBDHDocument setReceiver(@Nonnull @Nonempty
                                                String sScheme,
                                                @Nonnull @Nonempty
                                                String sValue)

Set the receiver identifier.

Parameters:

sScheme - The PEPPOL identifier scheme. This is usually always PeppolIdentifierHelper.DEFAULT_PARTICIPANT_SCHEME . May neither be null nor empty. This field is mapped to StandardBusinessDocumentHeader/Receiver/Identifier/@Authority .

sValue - The receiver identifier value. May neither be null nor empty. This field is mapped to StandardBusinessDocumentHeader/Receiver/Identifier/.

Returns:

this

setReceiverWithDefaultScheme

@Nonnull
public PeppolSBDHDocument setReceiverWithDefaultScheme(@Nonnull @Nonempty
                                                                 String sValue)

Set the receiver identifier value using the default identifier scheme/authority PeppolIdentifierHelper.DEFAULT_PARTICIPANT_SCHEME.

Parameters:

sValue - The sender identifier value. May neither be null nor empty. This field is mapped to StandardBusinessDocumentHeader/Receiver/Identifier/.

Returns:

this

getReceiverScheme

@Nullable
public String getReceiverScheme()

Returns:

The receiver identifier scheme. May be null if not initialized. This field is mapped to StandardBusinessDocumentHeader/Receiver/Identifier/@Authority .

getReceiverValue

@Nullable
public String getReceiverValue()

Returns:

The receiver identifier value. May be null if not initialized. This field is mapped to StandardBusinessDocumentHeader/Receiver/Identifier/.

getReceiverAsIdentifier

@Nullable
public com.helger.peppol.identifier.generic.participant.IParticipantIdentifier getReceiverAsIdentifier()

Returns:

The receiver identifier as a participant identifier or null if certain information are missing or are invalid.

setDocumentType

@Nonnull
public PeppolSBDHDocument setDocumentType(@Nonnull @Nonempty
                                                    String sScheme,
                                                    @Nonnull @Nonempty
                                                    String sValue)

Set the document type identifier.

Parameters:

sScheme - The document type identifier scheme. May neither be null nor empty.

sValue - The document type identifier value. May neither be null nor empty. This field is mapped to StandardBusinessDocumentHeader/BusinessScope/Scope[Type/text()="DOCUMENTID"]/InstanceIdentifier .

Returns:

this

setDocumentTypeWithDefaultScheme

@Nonnull
public PeppolSBDHDocument setDocumentTypeWithDefaultScheme(@Nonnull @Nonempty
                                                                     String sValue)

Set the document type identifier using the default identifier scheme/authority PeppolIdentifierHelper.DEFAULT_DOCUMENT_TYPE_SCHEME .

Parameters:

sValue - The document type identifier value. May neither be null nor empty. This field is mapped to StandardBusinessDocumentHeader/BusinessScope/Scope[Type/text()="DOCUMENTID"]/InstanceIdentifier .

Returns:

this

getDocumentTypeScheme

@Nullable
public String getDocumentTypeScheme()

Returns:

The document type identifier scheme. May be null if not initialized yet. This field is currently not mapped.

getDocumentTypeValue

@Nullable
public String getDocumentTypeValue()

Returns:

The document type identifier value. May be null if not initialized yet. This field is mapped to StandardBusinessDocumentHeader/BusinessScope/Scope[Type/text()="DOCUMENTID"]/InstanceIdentifier .

getDocumentTypeAsIdentifier

@Nullable
public com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier getDocumentTypeAsIdentifier()

Returns:

The document type identifier as an object or null if certain information are missing or are invalid.

setProcess

@Nonnull
public PeppolSBDHDocument setProcess(@Nonnull @Nonempty
                                               String sScheme,
                                               @Nonnull @Nonempty
                                               String sValue)

Set the process identifier.

Parameters:

sScheme - The process identifier scheme. May neither be null nor empty.

sValue - The process identifier. May neither be null nor empty. This field is mapped to StandardBusinessDocumentHeader/BusinessScope/Scope[Type/text()="PROCESSID"]/InstanceIdentifier .

Returns:

this

setProcessWithDefaultScheme

@Nonnull
public PeppolSBDHDocument setProcessWithDefaultScheme(@Nonnull @Nonempty
                                                                String sValue)

Set the document type identifier using the default identifier scheme/authority PeppolIdentifierHelper.DEFAULT_PROCESS_SCHEME.

Parameters:

sValue - The process identifier. May neither be null nor empty. This field is mapped to StandardBusinessDocumentHeader/BusinessScope/Scope[Type/text()="PROCESSID"]/InstanceIdentifier .

Returns:

this

getProcessScheme

@Nullable
public String getProcessScheme()

Returns:

The process identifier scheme. May be null if not initialized yet. This field is currently not mapped.

getProcessValue

@Nullable
public String getProcessValue()

Returns:

The process identifier value. May be null if not initialized yet. This field is mapped to StandardBusinessDocumentHeader/BusinessScope/Scope[Type/text()="PROCESSID"]/InstanceIdentifier .

getProcessAsIdentifier

@Nullable
public com.helger.peppol.identifier.generic.process.IProcessIdentifier getProcessAsIdentifier()

Returns:

The process identifier as an object or null if certain information are missing or are invalid.

setDocumentIdentification

@Nonnull
public PeppolSBDHDocument setDocumentIdentification(@Nonnull
                                                              String sStandard,
                                                              @Nonnull
                                                              String sTypeVersion,
                                                              @Nonnull
                                                              String sType,
                                                              @Nonnull
                                                              String sInstanceIdentifier,
                                                              @Nonnull
                                                              LocalDateTime aCreationDateAndTime)

Set the content of the fields that are mapped to StandardBusinessDocumentHeader/DocumentIdentification.

Parameters:

sStandard - The standard of the enveloped business message, normally described by use of the XML namespace of the business message root element (such as urn:oasis:names:specification: ubl:schema:xsd:Order-2). May not be null. This field is mapped to StandardBusinessDocumentHeader/DocumentIdentification/Standard .

sTypeVersion - The version number of the enveloped business message (such as the value "2.1" for OASIS UBL 2.1 or "2.0" for OASIS UBL 2.0). May not be null. This field is mapped to StandardBusinessDocumentHeader/DocumentIdentification/TypeVersion .

sType - Message type - mandatory in SBDH. XML local element name of the root-element in the business message. May not be null. This field is mapped to StandardBusinessDocumentHeader/DocumentIdentification/Type .

sInstanceIdentifier - An informative unique ID created by the issuer of the envelope. The InstanceIdentifier MUST be unique for each Business Message Envelope being created. This ID is not the same as the ID of the business message (such as the Invoice Number). It is not the same as a transmission Message ID generated by the application sending the message (as defined in AS2 or START).
The InstanceIdentifier MUST be globally unique and it is RECOMMENDED to use UUID (such as 118e3040-51d2-11e3-8f96-0800200c9a66). May not be null. This field is mapped to StandardBusinessDocumentHeader/DocumentIdentification/InstanceIdentifier .

aCreationDateAndTime - The date and time for when this envelope was created. It is NOT necessarily the same as the issue date of the business document (such as the invoice) being enveloped. It is NOT necessarily the date time for transmission.
The format of the value of this MUST include timezone information. May not be null. This field is mapped to StandardBusinessDocumentHeader/DocumentIdentification/CreationDateAndTime .

Returns:

this

getStandard

@Nullable
public String getStandard()

The standard of the enveloped business message, normally described by use of the XML namespace of the business message root element (such as urn:oasis:names:specification:ubl:schema:xsd:Order-2). This field is mapped to StandardBusinessDocumentHeader/DocumentIdentification/Standard .

Returns:

The standard value. May be null.

getTypeVersion

@Nullable
public String getTypeVersion()

The version number of the enveloped business message (such as the value "2.1" for OASIS UBL 2.1 or "2.0" for OASIS UBL 2.0). This field is mapped to StandardBusinessDocumentHeader/DocumentIdentification/TypeVersion .

Returns:

The type version. May be null.

getType

@Nullable
public String getType()

Message type - mandatory in SBDH. XML local element name of the root-element in the business message. This field is mapped to StandardBusinessDocumentHeader/DocumentIdentification/Type.

Returns:

Type value. May be null.

getInstanceIdentifier

@Nullable
public String getInstanceIdentifier()

An informative unique ID created by the issuer of the envelope. The InstanceIdentifier MUST be unique for each Business Message Envelope being created. This ID is not the same as the ID of the business message (such as the Invoice Number). It is not the same as a transmission Message ID generated by the application sending the message (as defined in AS2 or START).
The InstanceIdentifier MUST be globally unique and it is RECOMMENDED to use UUID (such as 118e3040-51d2-11e3-8f96-0800200c9a66). This field is mapped to StandardBusinessDocumentHeader/DocumentIdentification/InstanceIdentifier .

Returns:

The instance identifier. May be null.

getCreationDateAndTime

@Nullable
public LocalDateTime getCreationDateAndTime()

The date and time for when this envelope was created. It is NOT necessarily the same as the issue date of the business document (such as the invoice) being enveloped. It is NOT necessarily the date time for transmission.
The format of the value of this MUST include timezone information. This field is mapped to StandardBusinessDocumentHeader/DocumentIdentification/CreationDateAndTime .

Returns:

The creation date time. May be null.

setBusinessMessage

@Nonnull
public PeppolSBDHDocument setBusinessMessage(@Nonnull
                                                       Element aBusinessMessage)

Set the main business message that should be transmitted together with the SBDH.

Parameters:

aBusinessMessage - The business message to be set. May not be null. Internally the passed element is cloned, so that further modifications outside of this method have no impact on the business message inside this object.

Returns:

this

hasBusinessMessage

public boolean hasBusinessMessage()

Check if a business message is present without having the need to explicitly call getBusinessMessage() which returns a cloned node and is therefore an expensive operation.

Returns:

true if a business message is present, false otherwise.

getBusinessMessage

@Nullable
 @ReturnsMutableCopy
public Element getBusinessMessage()

Get the contained business message.

Returns:

null if no business message is present. A clone (deep copy) of the business message otherwise.

areAllFieldsSet

public boolean areAllFieldsSet()

Returns:

true if all mandatory fields required for creating an SBDH are present, false if at least one field is not set.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

create

@Nonnull
 @Deprecated
public static PeppolSBDHDocument create(@Nonnull
                                                                Element aBusinessMessage)

Deprecated.

Create a new PeppolSBDHDocument object for a business message. The resulting object has all required fields set, except for:

• sender ID
• receiver ID
• document type ID
• and process ID

Parameters:

aBusinessMessage - The XML business message. May not be null.

Returns:

A pre-filled PeppolSBDHDocument object with some information still missing.

See Also:

setSender(String, String), setReceiver(String, String), setDocumentType(String, String), setProcess(String, String)

create

@Nonnull
public static PeppolSBDHDocument create(@Nonnull
                                                  Element aBusinessMessage,
                                                  @Nonnull
                                                  com.helger.peppol.identifier.factory.IIdentifierFactory aIdentifierFactory)

Create a new PeppolSBDHDocument object for a business message. The resulting object has all required fields set, except for:

• sender ID
• receiver ID
• document type ID
• and process ID

Parameters:

aBusinessMessage - The XML business message. May not be null.

aIdentifierFactory - Identifier factory to be used. May not be null.

Returns:

A pre-filled PeppolSBDHDocument object with some information still missing.

Since:

5.2.6

See Also:

setSender(String, String), setReceiver(String, String), setDocumentType(String, String), setProcess(String, String)