com.helger.peppol.sbdh.read

Enum EPeppolSBDHDocumentReadError

java.lang.Object

java.lang.Enum<EPeppolSBDHDocumentReadError>

com.helger.peppol.sbdh.read.EPeppolSBDHDocumentReadError

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, Serializable, Comparable<EPeppolSBDHDocumentReadError>

public enum EPeppolSBDHDocumentReadError
extends Enum<EPeppolSBDHDocumentReadError>
implements com.helger.commons.id.IHasID<String>

This enum contains all the errors that can occur during SBD reading

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUSINESS_SCOPE_MISSING The "BusinessScope" element is missing
INVALID_BUSINESS_MESSAGE The main business message is invalid
INVALID_BUSINESS_MESSAGE_TYPE The main business message must be an XML element
INVALID_CREATION_DATE_TIME The value of the "DocumentIdentification/CreationDateAndTime" element is invalid
INVALID_DOCUMENT_TYPE_IDENTIFIER The provided document type identifier is invalid
INVALID_HEADER_VERSION The "HeaderVersion" element has an illegal value
INVALID_INSTANCE_IDENTIFIER The value of the "DocumentIdentification/InstanceIdentifier" element is invalid
INVALID_PROCESS_IDENTIFIER The provided process identifier is invalid
INVALID_RECEIVER_AUTHORITY The "Receiver/Identifier/Authority" attribute has an invalid value
INVALID_RECEIVER_COUNT Not exactly one "Receiver" element is present
INVALID_RECEIVER_VALUE The "Receiver/Identifier" has an invalid value
INVALID_SBD_XML Failed to interpret StandardBusinessDocument as XML
INVALID_SCOPE_COUNT At least two "BusinessScope/Scope" elements must be present
INVALID_SENDER_AUTHORITY The "Sender/Identifier/Authority" attribute has an invalid value
INVALID_SENDER_COUNT Not exactly one "Sender" element is present
INVALID_SENDER_VALUE The "Sender/Identifier" has an invalid value
INVALID_STANDARD The value of the "DocumentIdentification/Standard" element is invalid
INVALID_TYPE The value of the "DocumentIdentification/Type" element is invalid
INVALID_TYPE_VERSION The value of the "DocumentIdentification/TypeVersion" element is invalid
MISSING_DOCUMENT_TYPE_IDENTIFIER The document type identifier is missing
MISSING_PROCESS_IDENTIFIER The process identifier is missing
MISSING_SBDH The StandardBusinessDocumentHeader element is not present

Method Summary

Modifier and Type	Method and Description
String	getErrorMessage()
static EPeppolSBDHDocumentReadError	getFromIDOrNull(String sID)
String	getID()
static EPeppolSBDHDocumentReadError	valueOf(String name) Returns the enum constant of this type with the specified name.
static EPeppolSBDHDocumentReadError[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getComparatorID

Enum Constant Detail

INVALID_SBD_XML

public static final EPeppolSBDHDocumentReadError INVALID_SBD_XML

Failed to interpret StandardBusinessDocument as XML

MISSING_SBDH

public static final EPeppolSBDHDocumentReadError MISSING_SBDH

The StandardBusinessDocumentHeader element is not present

INVALID_HEADER_VERSION

public static final EPeppolSBDHDocumentReadError INVALID_HEADER_VERSION

The "HeaderVersion" element has an illegal value

INVALID_SENDER_COUNT

public static final EPeppolSBDHDocumentReadError INVALID_SENDER_COUNT

Not exactly one "Sender" element is present

INVALID_SENDER_AUTHORITY

public static final EPeppolSBDHDocumentReadError INVALID_SENDER_AUTHORITY

The "Sender/Identifier/Authority" attribute has an invalid value

INVALID_SENDER_VALUE

public static final EPeppolSBDHDocumentReadError INVALID_SENDER_VALUE

The "Sender/Identifier" has an invalid value

INVALID_RECEIVER_COUNT

public static final EPeppolSBDHDocumentReadError INVALID_RECEIVER_COUNT

Not exactly one "Receiver" element is present

INVALID_RECEIVER_AUTHORITY

public static final EPeppolSBDHDocumentReadError INVALID_RECEIVER_AUTHORITY

The "Receiver/Identifier/Authority" attribute has an invalid value

INVALID_RECEIVER_VALUE

public static final EPeppolSBDHDocumentReadError INVALID_RECEIVER_VALUE

The "Receiver/Identifier" has an invalid value

BUSINESS_SCOPE_MISSING

public static final EPeppolSBDHDocumentReadError BUSINESS_SCOPE_MISSING

The "BusinessScope" element is missing

INVALID_SCOPE_COUNT

public static final EPeppolSBDHDocumentReadError INVALID_SCOPE_COUNT

At least two "BusinessScope/Scope" elements must be present

INVALID_DOCUMENT_TYPE_IDENTIFIER

public static final EPeppolSBDHDocumentReadError INVALID_DOCUMENT_TYPE_IDENTIFIER

The provided document type identifier is invalid

INVALID_PROCESS_IDENTIFIER

public static final EPeppolSBDHDocumentReadError INVALID_PROCESS_IDENTIFIER

The provided process identifier is invalid

MISSING_DOCUMENT_TYPE_IDENTIFIER

public static final EPeppolSBDHDocumentReadError MISSING_DOCUMENT_TYPE_IDENTIFIER

The document type identifier is missing

MISSING_PROCESS_IDENTIFIER

public static final EPeppolSBDHDocumentReadError MISSING_PROCESS_IDENTIFIER

The process identifier is missing

INVALID_BUSINESS_MESSAGE_TYPE

public static final EPeppolSBDHDocumentReadError INVALID_BUSINESS_MESSAGE_TYPE

The main business message must be an XML element

INVALID_BUSINESS_MESSAGE

public static final EPeppolSBDHDocumentReadError INVALID_BUSINESS_MESSAGE

The main business message is invalid

INVALID_STANDARD

public static final EPeppolSBDHDocumentReadError INVALID_STANDARD

The value of the "DocumentIdentification/Standard" element is invalid

INVALID_TYPE_VERSION

public static final EPeppolSBDHDocumentReadError INVALID_TYPE_VERSION

The value of the "DocumentIdentification/TypeVersion" element is invalid

INVALID_TYPE

public static final EPeppolSBDHDocumentReadError INVALID_TYPE

The value of the "DocumentIdentification/Type" element is invalid

INVALID_INSTANCE_IDENTIFIER

public static final EPeppolSBDHDocumentReadError INVALID_INSTANCE_IDENTIFIER

The value of the "DocumentIdentification/InstanceIdentifier" element is invalid

INVALID_CREATION_DATE_TIME

public static final EPeppolSBDHDocumentReadError INVALID_CREATION_DATE_TIME

The value of the "DocumentIdentification/CreationDateAndTime" element is invalid

Method Detail

values

public static EPeppolSBDHDocumentReadError[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EPeppolSBDHDocumentReadError c : EPeppolSBDHDocumentReadError.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EPeppolSBDHDocumentReadError valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getID

@Nonnull
 @Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

getErrorMessage

@Nonnull
 @Nonempty
public String getErrorMessage()

getFromIDOrNull

@Nullable
public static EPeppolSBDHDocumentReadError getFromIDOrNull(@Nullable
                                                                      String sID)