com.helger.peppol.validation.api

Interface ISpecificationProfile

All Superinterfaces:

com.helger.commons.text.display.IHasDisplayText, Serializable

All Known Implementing Classes:

EBII2Profile

public interface ISpecificationProfile
extends com.helger.commons.text.display.IHasDisplayText

Defines a predefined specification profile. Each profile consists of a set of transactions (ISpecificationTransaction) and belongs to a group ISpecificationGroup (derived from the transactions).

Author:

PEPPOL.AT, BRZ, Philip Helger

Method Summary

Modifier and Type	Method and Description
boolean	containsTransaction(ISpecificationTransaction aTransaction) Check if the passed transaction is contained in this profile.
com.helger.commons.collection.ext.ICommonsList<? extends ISpecificationTransaction>	getAllTransactions()
ISpecificationGroup	getGroup()
int	getNumber()

Methods inherited from interface com.helger.commons.text.display.IHasDisplayText

getComparatorCollating, getDisplayText

Method Detail

getNumber

@Nonnegative
int getNumber()

Returns:

The numeric value of this profile (e.g. BII04 returns 4, BII22 returns 22 etc.). Some special profiles (like BII2 MLR) return 0!

getGroup

@Nonnull
ISpecificationGroup getGroup()

Returns:

The group to which all transaction belong. Never null.

getAllTransactions

@Nonnull
 @Nonempty
 @ReturnsMutableCopy
com.helger.commons.collection.ext.ICommonsList<? extends ISpecificationTransaction> getAllTransactions()

Returns:

A non-null non empty list of all transactions contained in this profile.

containsTransaction

boolean containsTransaction(@Nullable
                            ISpecificationTransaction aTransaction)

Check if the passed transaction is contained in this profile.

Parameters:

aTransaction - The transaction to query. May be null.

Returns:

true if the passed transaction is contained in this profile, false otherwise.