EUBL20DocumentType (ph-ubl 3.3.1 API)

java.lang.Object
- java.lang.Enum<EUBL20DocumentType>
- - com.helger.ubl.EUBL20DocumentType

All Implemented Interfaces:

com.helger.commons.xml.schema.IHasSchema, IUBLDocumentType, Serializable, Comparable<EUBL20DocumentType>
```
public enum EUBL20DocumentType
extends Enum<EUBL20DocumentType>
implements IUBLDocumentType
```
Enumeration with all available UBL 2.0 document types.

Author:

Philip Helger

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APPLICATION_RESPONSE`
`ATTACHED_DOCUMENT`
`BILL_OF_LADING`
`CATALOGUE`
`CATALOGUE_DELETION`
`CATALOGUE_ITEM_SPECIFICATION_UPDATE`
`CATALOGUE_PRICING_UPDATE`
`CATALOGUE_REQUEST`
`CERTIFICATE_OF_ORIGIN`
`CREDIT_NOTE`
`DEBIT_NOTE`
`DESPATCH_ADVICE`
`FORWARDING_INSTRUCTIONS`
`FREIGHT_INVOICE`
`INVOICE`
`ORDER`
`ORDER_CANCELLATION`
`ORDER_CHANGE`
`ORDER_RESPONSE`
`ORDER_RESPONSE_SIMPLE`
`PACKING_LIST`
`QUOTATION`
`RECEIPT_ADVICE`
`REMINDER`
`REMITTANCE_ADVICE`
`REQUEST_FOR_QUOTATION`
`SELF_BILLED_CREDIT_NOTE`
`SELF_BILLED_INVOICE`
`STATEMENT`
`TRANSPORTATION_STATUS`
`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 EUBL20DocumentType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static EUBL20DocumentType[]`	`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 EUBL20DocumentType APPLICATION_RESPONSE
```
  - ATTACHED_DOCUMENT
```
public static final EUBL20DocumentType ATTACHED_DOCUMENT
```
  - BILL_OF_LADING
```
public static final EUBL20DocumentType BILL_OF_LADING
```
  - CATALOGUE
```
public static final EUBL20DocumentType CATALOGUE
```
  - CATALOGUE_DELETION
```
public static final EUBL20DocumentType CATALOGUE_DELETION
```
  - CATALOGUE_ITEM_SPECIFICATION_UPDATE
```
public static final EUBL20DocumentType CATALOGUE_ITEM_SPECIFICATION_UPDATE
```
  - CATALOGUE_PRICING_UPDATE
```
public static final EUBL20DocumentType CATALOGUE_PRICING_UPDATE
```
  - CATALOGUE_REQUEST
```
public static final EUBL20DocumentType CATALOGUE_REQUEST
```
  - CERTIFICATE_OF_ORIGIN
```
public static final EUBL20DocumentType CERTIFICATE_OF_ORIGIN
```
  - CREDIT_NOTE
```
public static final EUBL20DocumentType CREDIT_NOTE
```
  - DEBIT_NOTE
```
public static final EUBL20DocumentType DEBIT_NOTE
```
  - DESPATCH_ADVICE
```
public static final EUBL20DocumentType DESPATCH_ADVICE
```
  - FORWARDING_INSTRUCTIONS
```
public static final EUBL20DocumentType FORWARDING_INSTRUCTIONS
```
  - FREIGHT_INVOICE
```
public static final EUBL20DocumentType FREIGHT_INVOICE
```
  - INVOICE
```
public static final EUBL20DocumentType INVOICE
```
  - ORDER
```
public static final EUBL20DocumentType ORDER
```
  - ORDER_CANCELLATION
```
public static final EUBL20DocumentType ORDER_CANCELLATION
```
  - ORDER_CHANGE
```
public static final EUBL20DocumentType ORDER_CHANGE
```
  - ORDER_RESPONSE
```
public static final EUBL20DocumentType ORDER_RESPONSE
```
  - ORDER_RESPONSE_SIMPLE
```
public static final EUBL20DocumentType ORDER_RESPONSE_SIMPLE
```
  - PACKING_LIST
```
public static final EUBL20DocumentType PACKING_LIST
```
  - QUOTATION
```
public static final EUBL20DocumentType QUOTATION
```
  - RECEIPT_ADVICE
```
public static final EUBL20DocumentType RECEIPT_ADVICE
```
  - REMINDER
```
public static final EUBL20DocumentType REMINDER
```
  - REMITTANCE_ADVICE
```
public static final EUBL20DocumentType REMITTANCE_ADVICE
```
  - REQUEST_FOR_QUOTATION
```
public static final EUBL20DocumentType REQUEST_FOR_QUOTATION
```
  - SELF_BILLED_CREDIT_NOTE
```
public static final EUBL20DocumentType SELF_BILLED_CREDIT_NOTE
```
  - SELF_BILLED_INVOICE
```
public static final EUBL20DocumentType SELF_BILLED_INVOICE
```
  - STATEMENT
```
public static final EUBL20DocumentType STATEMENT
```
  - TRANSPORTATION_STATUS
```
public static final EUBL20DocumentType TRANSPORTATION_STATUS
```
  - WAYBILL
```
public static final EUBL20DocumentType WAYBILL
```
- Method Detail
  - values
```
public static EUBL20DocumentType[] 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 (EUBL20DocumentType c : EUBL20DocumentType.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EUBL20DocumentType 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.

Enum EUBL20DocumentType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

APPLICATION_RESPONSE

ATTACHED_DOCUMENT

BILL_OF_LADING

CATALOGUE

CATALOGUE_DELETION

CATALOGUE_ITEM_SPECIFICATION_UPDATE

CATALOGUE_PRICING_UPDATE

CATALOGUE_REQUEST

CERTIFICATE_OF_ORIGIN

CREDIT_NOTE

DEBIT_NOTE

DESPATCH_ADVICE

FORWARDING_INSTRUCTIONS

FREIGHT_INVOICE

INVOICE

ORDER

ORDER_CANCELLATION

ORDER_CHANGE

ORDER_RESPONSE

ORDER_RESPONSE_SIMPLE

PACKING_LIST

QUOTATION

RECEIPT_ADVICE

REMINDER

REMITTANCE_ADVICE

REQUEST_FOR_QUOTATION

SELF_BILLED_CREDIT_NOTE

SELF_BILLED_INVOICE

STATEMENT

TRANSPORTATION_STATUS

WAYBILL

Method Detail

values

valueOf

getImplementationClass

getPackage

getLocalName

getNamespaceURI

getQName

getXSDPath

getXSDResource

getSchema

getValidator

validateXML