com.helger.ubl

Enum EUBL21DocumentType

java.lang.Object

java.lang.Enum<EUBL21DocumentType>

com.helger.ubl.EUBL21DocumentType

All Implemented Interfaces:

com.helger.commons.xml.schema.IHasSchema, IUBLDocumentType, Serializable, Comparable<EUBL21DocumentType>

public enum EUBL21DocumentType
extends Enum<EUBL21DocumentType>
implements IUBLDocumentType

Enumeration with all available UBL 2.1 document types.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLICATION_RESPONSE
ATTACHED_DOCUMENT
AWARDED_NOTIFICATION
BILL_OF_LADING
CALL_FOR_TENDERS
CATALOGUE
CATALOGUE_DELETION
CATALOGUE_ITEM_SPECIFICATION_UPDATE
CATALOGUE_PRICING_UPDATE
CATALOGUE_REQUEST
CERTIFICATE_OF_ORIGIN
CONTRACT_AWARD_NOTICE
CONTRACT_NOTICE
CREDIT_NOTE
DEBIT_NOTE
DESPATCH_ADVICE
DOCUMENT_STATUS
DOCUMENT_STATUS_REQUEST
EXCEPTION_CRITERIA
EXCEPTION_NOTIFICATION
FORECAST
FORECAST_REVISION
FORWARDING_INSTRUCTIONS
FREIGHT_INVOICE
FULFILMENT_CANCELATION
GOODS_ITEM_ITINERARY
GUARANTEE_CERTIFICATE
INSTRUCTION_FOR_RETURNS
INVENTORY_REPORT
INVOICE
ITEM_INFORMATION_REQUEST
ORDER
ORDER_CANCELLATION
ORDER_CHANGE
ORDER_RESPONSE
ORDER_RESPONSE_SIMPLE
PACKING_LIST
PRIOR_INFORMATION_NOTICE
PRODUCT_ACTIVITY
QUOTATION
RECEIPT_ADVICE
REMINDER
REMITTANCE_ADVICE
REQUEST_FOR_QUOTATION
RETAIL_EVENT
SELF_BILLED_CREDIT_NOTE
SELF_BILLED_INVOICE
STATEMENT
STOCK_AVAILABILITY_REPORT
TENDER
TENDER_QUALIFICATION
TENDER_QUALIFICATION_RESPONSE
TENDER_RECEIPT
TRADE_ITEM_LOCATION_PROFILE
TRANSPORT_EXECUTION_PLAN
TRANSPORT_EXECUTION_PLAN_REQUEST
TRANSPORT_PROGRESS_STATUS
TRANSPORT_PROGRESS_STATUS_REQUEST
TRANSPORT_SERVICE_DESCRIPTION
TRANSPORT_SERVICE_DESCRIPTION_REQUEST
TRANSPORTATION_STATUS
TRANSPORTATION_STATUS_REQUEST
UNAWARDED_NOTIFICATION
UTILITY_STATEMENT
WAYBILL

Method Summary

Methods

Modifier and Type	Method and Description
Class<?>	getImplementationClass()
String	getLocalName()
String	getNamespaceURI()
Package	getPackage()
QName	getQName()
Schema	getSchema()
Validator	getValidator()
String	getXSDPath()
com.helger.commons.io.IReadableResource	getXSDResource()
com.helger.commons.error.IResourceErrorGroup	validateXML(com.helger.commons.io.IReadableResource aXML) Validate the passed XML instance against the XML Schema of this document type.
static EUBL21DocumentType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EUBL21DocumentType[]	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

Enum Constant Detail

APPLICATION_RESPONSE

public static final EUBL21DocumentType APPLICATION_RESPONSE

ATTACHED_DOCUMENT

public static final EUBL21DocumentType ATTACHED_DOCUMENT

AWARDED_NOTIFICATION

public static final EUBL21DocumentType AWARDED_NOTIFICATION

BILL_OF_LADING

public static final EUBL21DocumentType BILL_OF_LADING

CALL_FOR_TENDERS

public static final EUBL21DocumentType CALL_FOR_TENDERS

CATALOGUE

public static final EUBL21DocumentType CATALOGUE

CATALOGUE_DELETION

public static final EUBL21DocumentType CATALOGUE_DELETION

CATALOGUE_ITEM_SPECIFICATION_UPDATE

public static final EUBL21DocumentType CATALOGUE_ITEM_SPECIFICATION_UPDATE

CATALOGUE_PRICING_UPDATE

public static final EUBL21DocumentType CATALOGUE_PRICING_UPDATE

CATALOGUE_REQUEST

public static final EUBL21DocumentType CATALOGUE_REQUEST

CERTIFICATE_OF_ORIGIN

public static final EUBL21DocumentType CERTIFICATE_OF_ORIGIN

CONTRACT_AWARD_NOTICE

public static final EUBL21DocumentType CONTRACT_AWARD_NOTICE

CONTRACT_NOTICE

public static final EUBL21DocumentType CONTRACT_NOTICE

CREDIT_NOTE

public static final EUBL21DocumentType CREDIT_NOTE

DEBIT_NOTE

public static final EUBL21DocumentType DEBIT_NOTE

DESPATCH_ADVICE

public static final EUBL21DocumentType DESPATCH_ADVICE

DOCUMENT_STATUS

public static final EUBL21DocumentType DOCUMENT_STATUS

DOCUMENT_STATUS_REQUEST

public static final EUBL21DocumentType DOCUMENT_STATUS_REQUEST

EXCEPTION_CRITERIA

public static final EUBL21DocumentType EXCEPTION_CRITERIA

EXCEPTION_NOTIFICATION

public static final EUBL21DocumentType EXCEPTION_NOTIFICATION

FORECAST

public static final EUBL21DocumentType FORECAST

FORECAST_REVISION

public static final EUBL21DocumentType FORECAST_REVISION

FORWARDING_INSTRUCTIONS

public static final EUBL21DocumentType FORWARDING_INSTRUCTIONS

FREIGHT_INVOICE

public static final EUBL21DocumentType FREIGHT_INVOICE

FULFILMENT_CANCELATION

public static final EUBL21DocumentType FULFILMENT_CANCELATION

GOODS_ITEM_ITINERARY

public static final EUBL21DocumentType GOODS_ITEM_ITINERARY

GUARANTEE_CERTIFICATE

public static final EUBL21DocumentType GUARANTEE_CERTIFICATE

INSTRUCTION_FOR_RETURNS

public static final EUBL21DocumentType INSTRUCTION_FOR_RETURNS

INVENTORY_REPORT

public static final EUBL21DocumentType INVENTORY_REPORT

INVOICE

public static final EUBL21DocumentType INVOICE

ITEM_INFORMATION_REQUEST

public static final EUBL21DocumentType ITEM_INFORMATION_REQUEST

ORDER

public static final EUBL21DocumentType ORDER

ORDER_CANCELLATION

public static final EUBL21DocumentType ORDER_CANCELLATION

ORDER_CHANGE

public static final EUBL21DocumentType ORDER_CHANGE

ORDER_RESPONSE

public static final EUBL21DocumentType ORDER_RESPONSE

ORDER_RESPONSE_SIMPLE

public static final EUBL21DocumentType ORDER_RESPONSE_SIMPLE

PACKING_LIST

public static final EUBL21DocumentType PACKING_LIST

PRIOR_INFORMATION_NOTICE

public static final EUBL21DocumentType PRIOR_INFORMATION_NOTICE

PRODUCT_ACTIVITY

public static final EUBL21DocumentType PRODUCT_ACTIVITY

QUOTATION

public static final EUBL21DocumentType QUOTATION

RECEIPT_ADVICE

public static final EUBL21DocumentType RECEIPT_ADVICE

REMINDER

public static final EUBL21DocumentType REMINDER

REMITTANCE_ADVICE

public static final EUBL21DocumentType REMITTANCE_ADVICE

REQUEST_FOR_QUOTATION

public static final EUBL21DocumentType REQUEST_FOR_QUOTATION

RETAIL_EVENT

public static final EUBL21DocumentType RETAIL_EVENT

SELF_BILLED_CREDIT_NOTE

public static final EUBL21DocumentType SELF_BILLED_CREDIT_NOTE

SELF_BILLED_INVOICE

public static final EUBL21DocumentType SELF_BILLED_INVOICE

STATEMENT

public static final EUBL21DocumentType STATEMENT

STOCK_AVAILABILITY_REPORT

public static final EUBL21DocumentType STOCK_AVAILABILITY_REPORT

TENDER

public static final EUBL21DocumentType TENDER

TENDER_QUALIFICATION

public static final EUBL21DocumentType TENDER_QUALIFICATION

TENDER_QUALIFICATION_RESPONSE

public static final EUBL21DocumentType TENDER_QUALIFICATION_RESPONSE

TENDER_RECEIPT

public static final EUBL21DocumentType TENDER_RECEIPT

TRADE_ITEM_LOCATION_PROFILE

public static final EUBL21DocumentType TRADE_ITEM_LOCATION_PROFILE

TRANSPORTATION_STATUS

public static final EUBL21DocumentType TRANSPORTATION_STATUS

TRANSPORTATION_STATUS_REQUEST

public static final EUBL21DocumentType TRANSPORTATION_STATUS_REQUEST

TRANSPORT_EXECUTION_PLAN

public static final EUBL21DocumentType TRANSPORT_EXECUTION_PLAN

TRANSPORT_EXECUTION_PLAN_REQUEST

public static final EUBL21DocumentType TRANSPORT_EXECUTION_PLAN_REQUEST

TRANSPORT_PROGRESS_STATUS

public static final EUBL21DocumentType TRANSPORT_PROGRESS_STATUS

TRANSPORT_PROGRESS_STATUS_REQUEST

public static final EUBL21DocumentType TRANSPORT_PROGRESS_STATUS_REQUEST

TRANSPORT_SERVICE_DESCRIPTION

public static final EUBL21DocumentType TRANSPORT_SERVICE_DESCRIPTION

TRANSPORT_SERVICE_DESCRIPTION_REQUEST

public static final EUBL21DocumentType TRANSPORT_SERVICE_DESCRIPTION_REQUEST

UNAWARDED_NOTIFICATION

public static final EUBL21DocumentType UNAWARDED_NOTIFICATION

UTILITY_STATEMENT

public static final EUBL21DocumentType UTILITY_STATEMENT

WAYBILL

public static final EUBL21DocumentType WAYBILL

Method Detail

values

public static EUBL21DocumentType[] 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 (EUBL21DocumentType c : EUBL21DocumentType.values())
    System.out.println(c);

Returns:

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

valueOf

public static EUBL21DocumentType 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

getImplementationClass

@Nonnull
public Class<?> getImplementationClass()

Specified by:

getImplementationClass in interface IUBLDocumentType

Returns:

The class implementing this document type. Never null.

getPackage

@Nonnull
public Package getPackage()

Specified by:

getPackage in interface IUBLDocumentType

Returns:

The package of the implementation class. Never null.

getLocalName

@Nonnull
public String getLocalName()

Specified by:

getLocalName in interface IUBLDocumentType

Returns:

The local name of the root element of an XML document of this type. Corresponds to the name of the implementation class (without a package).

getNamespaceURI

@Nonnull
public String getNamespaceURI()

Specified by:

getNamespaceURI in interface IUBLDocumentType

Returns:

The non-null XML namespace of this UBL document type.

getQName

@Nonnull
public QName getQName()

Specified by:

getQName in interface IUBLDocumentType

Returns:

The combination of local name and namespace URI matching this document type. Never null.

getXSDPath

@Nonnull
public String getXSDPath()

Specified by:

getXSDPath in interface IUBLDocumentType

Returns:

The path within the classpath where the main XSD file resides.

getXSDResource

@Nonnull
public com.helger.commons.io.IReadableResource getXSDResource()

Specified by:

getXSDResource in interface IUBLDocumentType

Returns:

The resource from which the XSD can be read.

getSchema

@Nonnull
public Schema getSchema()

Specified by:

getSchema in interface com.helger.commons.xml.schema.IHasSchema

Specified by:

getSchema in interface IUBLDocumentType

Returns:

The non-null compiled Schema object retrieved by the XMLSchemaCache.

getValidator

@Nonnull
public Validator getValidator()

Specified by:

getValidator in interface IUBLDocumentType

Returns:

The non-null compiled Validator object retrieved from the schema to be obtained from IUBLDocumentType.getSchema().

validateXML

@Nonnull
public com.helger.commons.error.IResourceErrorGroup validateXML(@Nonnull
                                                               com.helger.commons.io.IReadableResource aXML)

Description copied from interface: IUBLDocumentType

Validate the passed XML instance against the XML Schema of this document type.

Specified by:

validateXML in interface IUBLDocumentType

Parameters:

aXML - The XML resource to be validated.

Returns:

A non-null group of validation errors. Is empty if no error occurred.