com.helger.peppol.validation.api

Interface ISpecificationTransaction

All Superinterfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.name.IHasName, Serializable

All Known Implementing Classes:

EBII2Transaction

public interface ISpecificationTransaction
extends com.helger.commons.id.IHasID<String>, com.helger.commons.name.IHasName, Serializable

Represents a single transaction within a specification.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
ISpecificationGroup	getGroup()
String	getName()
int	getNumber()
String	getSubNumber()
String	getTransactionID()
String	getTransactionKey()
com.helger.ubl21.EUBL21DocumentType	getUBLDocumentType()
String	getVersionNumber()

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID, getID

Methods inherited from interface com.helger.commons.name.IHasName

getComparatorCollating, getComparatorName

Method Detail

getName

@Nonnull
 @Nonempty
String getName()

Specified by:

getName in interface com.helger.commons.name.IHasName

Returns:

The pseudo name of this transaction. Does not require translation. Neither null nor empty.

getNumber

@Nonnegative
int getNumber()

Returns:

The number of this transaction. This is only unique in combination with the "sub number", since e.g. in BII2 the number 64 is used 3 times but with the sub numbers A, B and C!

getSubNumber

@Nonnull
String getSubNumber()

Returns:

The sub number. This is e.g. relevant for BII2 transaction 64 which is split into A, B, and C. For all others this methods returns an empty string.

getGroup

@Nonnull
ISpecificationGroup getGroup()

Returns:

The underlying specification group to which this transaction belongs.

getTransactionID

@Nonnull
 @Nonempty
String getTransactionID()

Returns:

The complete transaction ID. For BII2 e.g. urn:www.cenbii.eu:transaction:biitrns040:ver1.0

getTransactionKey

@Nonnull
 @Nonempty
String getTransactionKey()

Returns:

The unique key. For BII2 e.g. "T064A" or "T004".

getVersionNumber

@Nonnull
 @Nonempty
String getVersionNumber()

Returns:

The version of the transaction. For BII2 e.g. "1.0" or "2.0".

getUBLDocumentType

@Nonnull
com.helger.ubl21.EUBL21DocumentType getUBLDocumentType()

Returns:

The expected UBL 2.1 document type for this transaction. Never null.