DocumentMetadataType (ph-ubl22 6.7.0 API)

java.lang.Object
- oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_22.DocumentMetadataType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class DocumentMetadataType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable
```
<pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ABIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Metadata. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe the metadata of a specific business document based on any document format (e.g. UBL, EDIFACT, ...).</ccts:Definition><ccts:ObjectClass>Document Metadata</ccts:ObjectClass></ccts:Component> </pre> Java class for DocumentMetadataType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <complexType name="DocumentMetadataType"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ID" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}FormatID"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}VersionID"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}SchemaURI" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}DocumentTypeCode" minOccurs="0"/> </sequence> </restriction> </complexContent> </complexType> </pre> This class was annotated by ph-jaxb22-plugin -Xph-annotate This class contains methods created by ph-jaxb22-plugin -Xph-equalshashcode This class contains methods created by ph-jaxb22-plugin -Xph-tostring This class contains methods created by ph-jaxb22-plugin -Xph-cloneable2 This class contains methods created by ph-jaxb22-plugin -Xph-value-extender

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentMetadataType()
Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Constructors
Constructor and Description
`DocumentMetadataType()` Default constructor<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentMetadataType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(DocumentMetadataType ret)` This method clones all values from <code>this</code> to the passed object.
`boolean`	`equals(Object o)` Created by ph-jaxb22-plugin -Xph-equalshashcode
`DocumentTypeCodeType`	`getDocumentTypeCode()` <pre> <?
`String`	`getDocumentTypeCodeValue()` Get the value of the contained DocumentTypeCodeType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`FormatIDType`	`getFormatID()` <pre> <?
`String`	`getFormatIDValue()` Get the value of the contained FormatIDType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`IDType`	`getID()` <pre> <?
`String`	`getIDValue()` Get the value of the contained IDType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`SchemaURIType`	`getSchemaURI()` <pre> <?
`String`	`getSchemaURIValue()` Get the value of the contained SchemaURIType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`VersionIDType`	`getVersionID()` <pre> <?
`String`	`getVersionIDValue()` Get the value of the contained VersionIDType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`void`	`setDocumentTypeCode(DocumentTypeCodeType value)` Sets the value of the documentTypeCode property.
`DocumentTypeCodeType`	`setDocumentTypeCode(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setFormatID(FormatIDType value)` Sets the value of the formatID property.
`FormatIDType`	`setFormatID(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setID(IDType value)` Sets the value of the id property.
`IDType`	`setID(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setSchemaURI(SchemaURIType value)` Sets the value of the schemaURI property.
`SchemaURIType`	`setSchemaURI(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`VersionIDType`	`setVersionID(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setVersionID(VersionIDType value)` Sets the value of the versionID property.
`String`	`toString()` Created by ph-jaxb22-plugin -Xph-tostring

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
 - DocumentMetadataType
```
public DocumentMetadataType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getID
```
@Nullable
public IDType getID()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Metadata. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for the document.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Metadata</ccts:ObjectClass><ccts:PropertyTerm>Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is IDType
 - setID
```
public void setID(@Nullable
 IDType value)
```
 Sets the value of the id property.
 
 Parameters:
 
 value - allowed object is IDType
 - getFormatID
```
@Nullable
public FormatIDType getFormatID()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Metadata. Format Identifier. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for the document format (e.g. standard business vocabularies).</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Document Metadata</ccts:ObjectClass><ccts:PropertyTerm>Format Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType><ccts:Examples>UBL, ISO20022, EDIFACT</ccts:Examples></ccts:Component> </pre>
 
 Returns:
 
 possible object is FormatIDType
 - setFormatID
```
public void setFormatID(@Nullable
 FormatIDType value)
```
 Sets the value of the formatID property.
 
 Parameters:
 
 value - allowed object is FormatIDType
 - getVersionID
```
@Nullable
public VersionIDType getVersionID()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Metadata. Version Identifier. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for a precise version of a document format.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Document Metadata</ccts:ObjectClass><ccts:PropertyTerm>Version Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType><ccts:Examples>2.2</ccts:Examples></ccts:Component> </pre>
 
 Returns:
 
 possible object is VersionIDType
 - setVersionID
```
public void setVersionID(@Nullable
 VersionIDType value)
```
 Sets the value of the versionID property.
 
 Parameters:
 
 value - allowed object is VersionIDType
 - getSchemaURI
```
@Nullable
public SchemaURIType getSchemaURI()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Metadata. Schema URI. Identifier</ccts:DictionaryEntryName><ccts:Definition>The Uniform Resource Identifier (URI) of a schema definition for the business document (e.g. a namespace URI for XML schemas, a message ID for non-xml legacy documents).</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Metadata</ccts:ObjectClass><ccts:PropertyTerm>Schema URI</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType><ccts:Examples>urn:oasis:names:specification:ubl:schema:xsd:Invoice-2, INVOIC</ccts:Examples></ccts:Component> </pre>
 
 Returns:
 
 possible object is SchemaURIType
 - setSchemaURI
```
public void setSchemaURI(@Nullable
 SchemaURIType value)
```
 Sets the value of the schemaURI property.
 
 Parameters:
 
 value - allowed object is SchemaURIType
 - getDocumentTypeCode
```
@Nullable
public DocumentTypeCodeType getDocumentTypeCode()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Metadata. Document Type Code. Code</ccts:DictionaryEntryName><ccts:Definition>The type of document, expressed as a code.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Metadata</ccts:ObjectClass><ccts:PropertyTerm>Document Type Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is DocumentTypeCodeType
 - setDocumentTypeCode
```
public void setDocumentTypeCode(@Nullable
 DocumentTypeCodeType value)
```
 Sets the value of the documentTypeCode property.
 
 Parameters:
 
 value - allowed object is DocumentTypeCodeType
 - equals
```
public boolean equals(Object o)
```
 Created by ph-jaxb22-plugin -Xph-equalshashcode
 
 Overrides:
 
 equals in class Object
 - hashCode
```
public int hashCode()
```
 Created by ph-jaxb22-plugin -Xph-equalshashcode
 
 Overrides:
 
 hashCode in class Object
 - toString
```
public String toString()
```
 Created by ph-jaxb22-plugin -Xph-tostring
 
 Overrides:
 
 toString in class Object
 - cloneTo
```
public void cloneTo(@Nonnull
 DocumentMetadataType ret)
```
 This method clones all values from <code>this</code> to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2
 
 Parameters:
 
 ret - The target object to clone to. May not be <code>null</code>.
 - clone
```
@Nonnull
 @ReturnsMutableCopy
public DocumentMetadataType clone()
```
 Created by ph-jaxb22-plugin -Xph-cloneable2
 
 Specified by:
 
 clone in interface com.helger.commons.lang.IExplicitlyCloneable
 
 Overrides:
 
 clone in class Object
 
 Returns:
 
 The cloned object. Never <code>null</code>.
 - setDocumentTypeCode
```
@Nonnull
public DocumentTypeCodeType setDocumentTypeCode(@Nullable
 String valueParam)
```
 Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type DocumentTypeCodeType and never <code>null</code>
 - setID
```
@Nonnull
public IDType setID(@Nullable
 String valueParam)
```
 Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type IDType and never <code>null</code>
 - setFormatID
```
@Nonnull
public FormatIDType setFormatID(@Nullable
 String valueParam)
```
 Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type FormatIDType and never <code>null</code>
 - setVersionID
```
@Nonnull
public VersionIDType setVersionID(@Nullable
 String valueParam)
```
 Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type VersionIDType and never <code>null</code>
 - setSchemaURI
```
@Nonnull
public SchemaURIType setSchemaURI(@Nullable
 String valueParam)
```
 Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type SchemaURIType and never <code>null</code>
 - getIDValue
```
@Nullable
public String getIDValue()
```
 Get the value of the contained IDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained IDType object or <code>null</code>
 - getFormatIDValue
```
@Nullable
public String getFormatIDValue()
```
 Get the value of the contained FormatIDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained FormatIDType object or <code>null</code>
 - getVersionIDValue
```
@Nullable
public String getVersionIDValue()
```
 Get the value of the contained VersionIDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained VersionIDType object or <code>null</code>
 - getSchemaURIValue
```
@Nullable
public String getSchemaURIValue()
```
 Get the value of the contained SchemaURIType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained SchemaURIType object or <code>null</code>
 - getDocumentTypeCodeValue
```
@Nullable
public String getDocumentTypeCodeValue()
```
 Get the value of the contained DocumentTypeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained DocumentTypeCodeType object or <code>null</code>

Class DocumentMetadataType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentMetadataType

Method Detail

getID

setID

getFormatID

setFormatID

getVersionID

setVersionID

getSchemaURI

setSchemaURI

getDocumentTypeCode

setDocumentTypeCode

equals

hashCode

toString

cloneTo

clone

setDocumentTypeCode

setID

setFormatID

setVersionID

setSchemaURI

getIDValue

getFormatIDValue

getVersionIDValue

getSchemaURIValue

getDocumentTypeCodeValue