oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21

Class DocumentReferenceType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.DocumentReferenceType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable

@CodingStyleguideUnaware
public class DocumentReferenceType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ABIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Details</ccts:DictionaryEntryName><ccts:Definition>A class to define a reference to a document.</ccts:Definition><ccts:ObjectClass>Document Reference</ccts:ObjectClass></ccts:Component>
 

Java class for DocumentReferenceType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="DocumentReferenceType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ID"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}CopyIndicator" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}UUID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}IssueDate" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}IssueTime" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}DocumentTypeCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}DocumentType" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}XPath" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}LanguageID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}LocaleCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}VersionID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}DocumentStatusCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}DocumentDescription" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Attachment" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ValidityPeriod" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}IssuerParty" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ResultOfVerification" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

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-list-extension

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
DocumentReferenceType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addDocumentDescription(DocumentDescriptionType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addXPath(XPathType elem) Created by ph-jaxb22-plugin -Xph-list-extension
DocumentReferenceType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(DocumentReferenceType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
AttachmentType	getAttachment() <?
CopyIndicatorType	getCopyIndicator() <?
List<DocumentDescriptionType>	getDocumentDescription() <?
DocumentDescriptionType	getDocumentDescriptionAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getDocumentDescriptionCount() Created by ph-jaxb22-plugin -Xph-list-extension
DocumentStatusCodeType	getDocumentStatusCode() <?
String	getDocumentStatusCodeValue() Get the value of the contained DocumentStatusCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
DocumentTypeType	getDocumentType() <?
DocumentTypeCodeType	getDocumentTypeCode() <?
String	getDocumentTypeCodeValue() Get the value of the contained DocumentTypeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
String	getDocumentTypeValue() Get the value of the contained DocumentTypeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
IDType	getID() <?
String	getIDValue() Get the value of the contained IDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
IssueDateType	getIssueDate() <?
LocalDate	getIssueDateValue() Get the value of the contained IssueDateType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
PartyType	getIssuerParty() <?
IssueTimeType	getIssueTime() <?
LocalTime	getIssueTimeValue() Get the value of the contained IssueTimeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
LanguageIDType	getLanguageID() <?
String	getLanguageIDValue() Get the value of the contained LanguageIDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
LocaleCodeType	getLocaleCode() <?
String	getLocaleCodeValue() Get the value of the contained LocaleCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
ResultOfVerificationType	getResultOfVerification() <?
UUIDType	getUUID() <?
String	getUUIDValue() Get the value of the contained UUIDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
PeriodType	getValidityPeriod() <?
VersionIDType	getVersionID() <?
String	getVersionIDValue() Get the value of the contained VersionIDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<XPathType>	getXPath() <?
XPathType	getXPathAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getXPathCount() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasDocumentDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoDocumentDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoXPathEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasXPathEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	isCopyIndicatorValue(boolean nullValue) Get the value of the contained CopyIndicatorType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setAttachment(AttachmentType value) Sets the value of the attachment property.
CopyIndicatorType	setCopyIndicator(boolean valueParam) Special setter with value of type boolean Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setCopyIndicator(CopyIndicatorType value) Sets the value of the copyIndicator property.
void	setDocumentDescription(List<DocumentDescriptionType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setDocumentStatusCode(DocumentStatusCodeType value) Sets the value of the documentStatusCode property.
DocumentStatusCodeType	setDocumentStatusCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setDocumentType(DocumentTypeType value) Sets the value of the documentType property.
DocumentTypeType	setDocumentType(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setDocumentTypeCode(DocumentTypeCodeType value) Sets the value of the documentTypeCode property.
DocumentTypeCodeType	setDocumentTypeCode(String valueParam) Special setter with value of type String 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 Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setIssueDate(IssueDateType value) Sets the value of the issueDate property.
IssueDateType	setIssueDate(LocalDate valueParam) Special setter with value of type LocalDate Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setIssuerParty(PartyType value) Sets the value of the issuerParty property.
void	setIssueTime(IssueTimeType value) Sets the value of the issueTime property.
IssueTimeType	setIssueTime(LocalTime valueParam) Special setter with value of type LocalTime Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setLanguageID(LanguageIDType value) Sets the value of the languageID property.
LanguageIDType	setLanguageID(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setLocaleCode(LocaleCodeType value) Sets the value of the localeCode property.
LocaleCodeType	setLocaleCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setResultOfVerification(ResultOfVerificationType value) Sets the value of the resultOfVerification property.
UUIDType	setUUID(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setUUID(UUIDType value) Sets the value of the uuid property.
void	setValidityPeriod(PeriodType value) Sets the value of the validityPeriod property.
VersionIDType	setVersionID(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setVersionID(VersionIDType value) Sets the value of the versionID property.
void	setXPath(List<XPathType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
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

DocumentReferenceType

public DocumentReferenceType()

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

Method Detail

getID

@Nullable
public IDType getID()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for the referenced document.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTerm>Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType><ccts:Examples>PO-001 3333-44-123 </ccts:Examples></ccts:Component>
 

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

getCopyIndicator

@Nullable
public CopyIndicatorType getCopyIndicator()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Copy_ Indicator. Indicator</ccts:DictionaryEntryName><ccts:Definition>An indicator that the referenced document is a copy (true) or the original (false).</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTermQualifier>Copy</ccts:PropertyTermQualifier><ccts:PropertyTerm>Indicator</ccts:PropertyTerm><ccts:RepresentationTerm>Indicator</ccts:RepresentationTerm><ccts:DataType>Indicator. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is CopyIndicatorType

setCopyIndicator

public void setCopyIndicator(@Nullable
                             CopyIndicatorType value)

Sets the value of the copyIndicator property.

Parameters:

value - allowed object is CopyIndicatorType

getUUID

@Nullable
public UUIDType getUUID()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. UUID. Identifier</ccts:DictionaryEntryName><ccts:Definition>A universally unique identifier for this document reference.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTerm>UUID</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is UUIDType

setUUID

public void setUUID(@Nullable
                    UUIDType value)

Sets the value of the uuid property.

Parameters:

value - allowed object is UUIDType

getIssueDate

@Nullable
public IssueDateType getIssueDate()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Issue Date. Date</ccts:DictionaryEntryName><ccts:Definition>The date, assigned by the sender of the referenced document, on which the document was issued.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTerm>Issue Date</ccts:PropertyTerm><ccts:RepresentationTerm>Date</ccts:RepresentationTerm><ccts:DataType>Date. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is IssueDateType

setIssueDate

public void setIssueDate(@Nullable
                         IssueDateType value)

Sets the value of the issueDate property.

Parameters:

value - allowed object is IssueDateType

getIssueTime

@Nullable
public IssueTimeType getIssueTime()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Issue Time. Time</ccts:DictionaryEntryName><ccts:Definition>The time, assigned by the sender of the referenced document, at which the document was issued.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTerm>Issue Time</ccts:PropertyTerm><ccts:RepresentationTerm>Time</ccts:RepresentationTerm><ccts:DataType>Time. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is IssueTimeType

setIssueTime

public void setIssueTime(@Nullable
                         IssueTimeType value)

Sets the value of the issueTime property.

Parameters:

value - allowed object is IssueTimeType

getDocumentTypeCode

@Nullable
public DocumentTypeCodeType getDocumentTypeCode()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Document Type Code. Code</ccts:DictionaryEntryName><ccts:Definition>The type of document being referenced, expressed as a code.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTerm>Document Type Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component>
 

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

getDocumentType

@Nullable
public DocumentTypeType getDocumentType()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Document Type. Text</ccts:DictionaryEntryName><ccts:Definition>The type of document being referenced, expressed as text.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTerm>Document Type</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is DocumentTypeType

setDocumentType

public void setDocumentType(@Nullable
                            DocumentTypeType value)

Sets the value of the documentType property.

Parameters:

value - allowed object is DocumentTypeType

getXPath

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<XPathType> getXPath()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. XPath. Text</ccts:DictionaryEntryName><ccts:Definition>A reference to another place in the same XML document instance in which DocumentReference appears.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTerm>XPath</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

Gets the value of the xPath property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the xPath property.

For example, to add a new item, do as follows:

    getXPath().add(newItem);
 

Objects of the following type(s) are allowed in the list XPathType

getLanguageID

@Nullable
public LanguageIDType getLanguageID()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Language. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for the language used in the referenced document.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTerm>Language</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is LanguageIDType

setLanguageID

public void setLanguageID(@Nullable
                          LanguageIDType value)

Sets the value of the languageID property.

Parameters:

value - allowed object is LanguageIDType

getLocaleCode

@Nullable
public LocaleCodeType getLocaleCode()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Locale Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code signifying the locale in which the language in the referenced document is used.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTerm>Locale Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is LocaleCodeType

setLocaleCode

public void setLocaleCode(@Nullable
                          LocaleCodeType value)

Sets the value of the localeCode property.

Parameters:

value - allowed object is LocaleCodeType

getVersionID

@Nullable
public VersionIDType getVersionID()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Version. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for the current version of the referenced document.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTerm>Version</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType><ccts:Examples>1.1 </ccts:Examples></ccts:Component>
 

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

getDocumentStatusCode

@Nullable
public DocumentStatusCodeType getDocumentStatusCode()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Document Status Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code signifying the status of the reference document with respect to its original state.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTerm>Document Status Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataTypeQualifier>Document Status</ccts:DataTypeQualifier><ccts:DataType>Document Status_ Code. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is DocumentStatusCodeType

setDocumentStatusCode

public void setDocumentStatusCode(@Nullable
                                  DocumentStatusCodeType value)

Sets the value of the documentStatusCode property.

Parameters:

value - allowed object is DocumentStatusCodeType

getDocumentDescription

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<DocumentDescriptionType> getDocumentDescription()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Document_ Description. Text</ccts:DictionaryEntryName><ccts:Definition>Text describing the referenced document.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTermQualifier>Document</ccts:PropertyTermQualifier><ccts:PropertyTerm>Description</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:Examples>stock no longer provided </ccts:Examples></ccts:Component>
 

Gets the value of the documentDescription property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the documentDescription property.

For example, to add a new item, do as follows:

    getDocumentDescription().add(newItem);
 

Objects of the following type(s) are allowed in the list DocumentDescriptionType

getAttachment

@Nullable
public AttachmentType getAttachment()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Attachment</ccts:DictionaryEntryName><ccts:Definition>The referenced document as an attachment to the document from which it is referenced.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTerm>Attachment</ccts:PropertyTerm><ccts:AssociatedObjectClass>Attachment</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Attachment</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is AttachmentType

setAttachment

public void setAttachment(@Nullable
                          AttachmentType value)

Sets the value of the attachment property.

Parameters:

value - allowed object is AttachmentType

getValidityPeriod

@Nullable
public PeriodType getValidityPeriod()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Validity_ Period. Period</ccts:DictionaryEntryName><ccts:Definition>The period for which this document reference is valid.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTermQualifier>Validity</ccts:PropertyTermQualifier><ccts:PropertyTerm>Period</ccts:PropertyTerm><ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Period</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is PeriodType

setValidityPeriod

public void setValidityPeriod(@Nullable
                              PeriodType value)

Sets the value of the validityPeriod property.

Parameters:

value - allowed object is PeriodType

getIssuerParty

@Nullable
public PartyType getIssuerParty()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Issuer_ Party. Party</ccts:DictionaryEntryName><ccts:Definition>The party who issued the referenced document.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTermQualifier>Issuer</ccts:PropertyTermQualifier><ccts:PropertyTerm>Party</ccts:PropertyTerm><ccts:AssociatedObjectClass>Party</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Party</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is PartyType

setIssuerParty

public void setIssuerParty(@Nullable
                           PartyType value)

Sets the value of the issuerParty property.

Parameters:

value - allowed object is PartyType

getResultOfVerification

@Nullable
public ResultOfVerificationType getResultOfVerification()

 <?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:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Reference. Result Of Verification</ccts:DictionaryEntryName><ccts:Definition>The result of an attempt to verify a signature associated with the referenced document.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Reference</ccts:ObjectClass><ccts:PropertyTerm>Result Of Verification</ccts:PropertyTerm><ccts:AssociatedObjectClass>Result Of Verification</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Result Of Verification</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is ResultOfVerificationType

setResultOfVerification

public void setResultOfVerification(@Nullable
                                    ResultOfVerificationType value)

Sets the value of the resultOfVerification property.

Parameters:

value - allowed object is ResultOfVerificationType

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

setXPath

public void setXPath(@Nullable
                     List<XPathType> aList)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

aList - The new list member to set. May be null.

setDocumentDescription

public void setDocumentDescription(@Nullable
                                   List<DocumentDescriptionType> aList)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

aList - The new list member to set. May be null.

hasXPathEntries

public boolean hasXPathEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if at least one item is contained, false otherwise.

hasNoXPathEntries

public boolean hasNoXPathEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if no item is contained, false otherwise.

getXPathCount

@Nonnegative
public int getXPathCount()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

The number of contained elements. Always ≥ 0.

getXPathAtIndex

@Nullable
public XPathType getXPathAtIndex(@Nonnegative
                                            int index)
                                     throws IndexOutOfBoundsException

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

index - The index to retrieve

Returns:

The element at the specified index. May be null

Throws:

IndexOutOfBoundsException - if the index is invalid!

addXPath

public void addXPath(@Nonnull
                     XPathType elem)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

elem - The element to be added. May not be null.

hasDocumentDescriptionEntries

public boolean hasDocumentDescriptionEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if at least one item is contained, false otherwise.

hasNoDocumentDescriptionEntries

public boolean hasNoDocumentDescriptionEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if no item is contained, false otherwise.

getDocumentDescriptionCount

@Nonnegative
public int getDocumentDescriptionCount()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

The number of contained elements. Always ≥ 0.

getDocumentDescriptionAtIndex

@Nullable
public DocumentDescriptionType getDocumentDescriptionAtIndex(@Nonnegative
                                                                        int index)
                                                                 throws IndexOutOfBoundsException

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

index - The index to retrieve

Returns:

The element at the specified index. May be null

Throws:

IndexOutOfBoundsException - if the index is invalid!

addDocumentDescription

public void addDocumentDescription(@Nonnull
                                   DocumentDescriptionType elem)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

elem - The element to be added. May not be null.

cloneTo

public void cloneTo(@Nonnull
                    DocumentReferenceType ret)

This method clones all values from this 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 null.

clone

@Nonnull
 @ReturnsMutableCopy
public DocumentReferenceType 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 null.

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 null.

Returns:

The created intermediary object of type DocumentTypeCodeType and never null

setLocaleCode

@Nonnull
public LocaleCodeType setLocaleCode(@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 null.

Returns:

The created intermediary object of type LocaleCodeType and never null

setDocumentStatusCode

@Nonnull
public DocumentStatusCodeType setDocumentStatusCode(@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 null.

Returns:

The created intermediary object of type DocumentStatusCodeType and never null

setIssueDate

@Nonnull
public IssueDateType setIssueDate(@Nullable
                                            LocalDate valueParam)

Special setter with value of type LocalDate
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type IssueDateType and never null

setIssueTime

@Nonnull
public IssueTimeType setIssueTime(@Nullable
                                            LocalTime valueParam)

Special setter with value of type LocalTime
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type IssueTimeType and never null

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 null.

Returns:

The created intermediary object of type IDType and never null

setUUID

@Nonnull
public UUIDType setUUID(@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 null.

Returns:

The created intermediary object of type UUIDType and never null

setLanguageID

@Nonnull
public LanguageIDType setLanguageID(@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 null.

Returns:

The created intermediary object of type LanguageIDType and never null

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 null.

Returns:

The created intermediary object of type VersionIDType and never null

setCopyIndicator

@Nonnull
public CopyIndicatorType setCopyIndicator(boolean valueParam)

Special setter with value of type boolean
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

valueParam - The value to be set.

Returns:

The created intermediary object of type CopyIndicatorType and never null

setDocumentType

@Nonnull
public DocumentTypeType setDocumentType(@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 null.

Returns:

The created intermediary object of type DocumentTypeType and never null

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 null

isCopyIndicatorValue

public boolean isCopyIndicatorValue(boolean nullValue)

Get the value of the contained CopyIndicatorType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

nullValue - The value to be returned, if the owning object is null

Returns:

Either the value of the contained CopyIndicatorType object or the passed nullValue

getUUIDValue

@Nullable
public String getUUIDValue()

Get the value of the contained UUIDType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained UUIDType object or null

getIssueDateValue

@Nullable
public LocalDate getIssueDateValue()

Get the value of the contained IssueDateType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained IssueDateType object or null

getIssueTimeValue

@Nullable
public LocalTime getIssueTimeValue()

Get the value of the contained IssueTimeType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained IssueTimeType object or null

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 null

getDocumentTypeValue

@Nullable
public String getDocumentTypeValue()

Get the value of the contained DocumentTypeType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained DocumentTypeType object or null

getLanguageIDValue

@Nullable
public String getLanguageIDValue()

Get the value of the contained LanguageIDType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained LanguageIDType object or null

getLocaleCodeValue

@Nullable
public String getLocaleCodeValue()

Get the value of the contained LocaleCodeType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained LocaleCodeType object or null

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 null

getDocumentStatusCodeValue

@Nullable
public String getDocumentStatusCodeValue()

Get the value of the contained DocumentStatusCodeType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained DocumentStatusCodeType object or null