DocumentResponseType (ph-ubl22 6.7.0 API)

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

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class DocumentResponseType
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 Response. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe an application-level response to a document.</ccts:Definition><ccts:ObjectClass>Document Response</ccts:ObjectClass></ccts:Component> </pre> Java class for DocumentResponseType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <complexType name="DocumentResponseType"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Response"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}DocumentReference" maxOccurs="unbounded"/> <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}RecipientParty" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}LineResponse" maxOccurs="unbounded" 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-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

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

Constructors
Constructor and Description
`DocumentResponseType()` 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
`void`	`addDocumentReference(DocumentReferenceType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`addLineResponse(LineResponseType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`DocumentResponseType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(DocumentResponseType 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
`List<DocumentReferenceType>`	`getDocumentReference()` <pre> <?
`DocumentReferenceType`	`getDocumentReferenceAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getDocumentReferenceCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`PartyType`	`getIssuerParty()` <pre> <?
`List<LineResponseType>`	`getLineResponse()` <pre> <?
`LineResponseType`	`getLineResponseAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getLineResponseCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`PartyType`	`getRecipientParty()` <pre> <?
`ResponseType`	`getResponse()` <pre> <?
`boolean`	`hasDocumentReferenceEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`boolean`	`hasLineResponseEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasNoDocumentReferenceEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasNoLineResponseEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setDocumentReference(List<DocumentReferenceType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setIssuerParty(PartyType value)` Sets the value of the issuerParty property.
`void`	`setLineResponse(List<LineResponseType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setRecipientParty(PartyType value)` Sets the value of the recipientParty property.
`void`	`setResponse(ResponseType value)` Sets the value of the response 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
 - DocumentResponseType
```
public DocumentResponseType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getResponse
```
@Nullable
public ResponseType getResponse()
```
 <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>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Response. Response</ccts:DictionaryEntryName><ccts:Definition>A response to the document as a whole.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Document Response</ccts:ObjectClass><ccts:PropertyTerm>Response</ccts:PropertyTerm><ccts:AssociatedObjectClass>Response</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Response</ccts:RepresentationTerm></ccts:Component> </pre>
 
 Returns:
 
 possible object is ResponseType
 - setResponse
```
public void setResponse(@Nullable
 ResponseType value)
```
 Sets the value of the response property.
 
 Parameters:
 
 value - allowed object is ResponseType
 - getDocumentReference
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<DocumentReferenceType> getDocumentReference()
```
 <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>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Response. Document Reference</ccts:DictionaryEntryName><ccts:Definition>A referenced document.</ccts:Definition><ccts:Cardinality>1..n</ccts:Cardinality><ccts:ObjectClass>Document Response</ccts:ObjectClass><ccts:PropertyTerm>Document Reference</ccts:PropertyTerm><ccts:AssociatedObjectClass>Document Reference</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Document Reference</ccts:RepresentationTerm></ccts:Component> </pre> Gets the value of the documentReference 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 <CODE>set</CODE> method for the documentReference property. For example, to add a new item, do as follows: <pre> getDocumentReference().add(newItem); </pre> Objects of the following type(s) are allowed in the list DocumentReferenceType
 - getIssuerParty
```
@Nullable
public PartyType getIssuerParty()
```
 <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>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Response. Issuer_ Party. Party</ccts:DictionaryEntryName><ccts:Definition>The party that issued the document.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Response</ccts:ObjectClass><ccts:PropertyTermQualifier>Issuer</ccts:PropertyTermQualifier><ccts:PropertyTerm>Party</ccts:PropertyTerm><ccts:AssociatedObjectClass>Party</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Party</ccts:RepresentationTerm></ccts:Component> </pre>
 
 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
 - getRecipientParty
```
@Nullable
public PartyType getRecipientParty()
```
 <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>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Response. Recipient_ Party. Party</ccts:DictionaryEntryName><ccts:Definition>The party for which the document is intended.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Document Response</ccts:ObjectClass><ccts:PropertyTermQualifier>Recipient</ccts:PropertyTermQualifier><ccts:PropertyTerm>Party</ccts:PropertyTerm><ccts:AssociatedObjectClass>Party</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Party</ccts:RepresentationTerm></ccts:Component> </pre>
 
 Returns:
 
 possible object is PartyType
 - setRecipientParty
```
public void setRecipientParty(@Nullable
 PartyType value)
```
 Sets the value of the recipientParty property.
 
 Parameters:
 
 value - allowed object is PartyType
 - getLineResponse
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<LineResponseType> getLineResponse()
```
 <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>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Response. Line Response</ccts:DictionaryEntryName><ccts:Definition>A response to a particular line in the document.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Document Response</ccts:ObjectClass><ccts:PropertyTerm>Line Response</ccts:PropertyTerm><ccts:AssociatedObjectClass>Line Response</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Line Response</ccts:RepresentationTerm></ccts:Component> </pre> Gets the value of the lineResponse 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 <CODE>set</CODE> method for the lineResponse property. For example, to add a new item, do as follows: <pre> getLineResponse().add(newItem); </pre> Objects of the following type(s) are allowed in the list LineResponseType
 - 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
 - setDocumentReference
```
public void setDocumentReference(@Nullable
 List<DocumentReferenceType> aList)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 aList - The new list member to set. May be <code>null</code>.
 - setLineResponse
```
public void setLineResponse(@Nullable
 List<LineResponseType> aList)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 aList - The new list member to set. May be <code>null</code>.
 - hasDocumentReferenceEntries
```
public boolean hasDocumentReferenceEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoDocumentReferenceEntries
```
public boolean hasNoDocumentReferenceEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> otherwise.
 - getDocumentReferenceCount
```
@Nonnegative
public int getDocumentReferenceCount()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 The number of contained elements. Always ≥ 0.
 - getDocumentReferenceAtIndex
```
@Nullable
public DocumentReferenceType getDocumentReferenceAtIndex(@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 <code>null</code>
 
 Throws:
 
 IndexOutOfBoundsException - if the index is invalid!
 - addDocumentReference
```
public void addDocumentReference(@Nonnull
 DocumentReferenceType elem)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 elem - The element to be added. May not be <code>null</code>.
 - hasLineResponseEntries
```
public boolean hasLineResponseEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoLineResponseEntries
```
public boolean hasNoLineResponseEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> otherwise.
 - getLineResponseCount
```
@Nonnegative
public int getLineResponseCount()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 The number of contained elements. Always ≥ 0.
 - getLineResponseAtIndex
```
@Nullable
public LineResponseType getLineResponseAtIndex(@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 <code>null</code>
 
 Throws:
 
 IndexOutOfBoundsException - if the index is invalid!
 - addLineResponse
```
public void addLineResponse(@Nonnull
 LineResponseType elem)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 elem - The element to be added. May not be <code>null</code>.
 - cloneTo
```
public void cloneTo(@Nonnull
 DocumentResponseType 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 DocumentResponseType 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>.

Class DocumentResponseType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentResponseType

Method Detail

getResponse

setResponse

getDocumentReference

getIssuerParty

setIssuerParty

getRecipientParty

setRecipientParty

getLineResponse

equals

hashCode

toString

setDocumentReference

setLineResponse

hasDocumentReferenceEntries

hasNoDocumentReferenceEntries

getDocumentReferenceCount

getDocumentReferenceAtIndex

addDocumentReference

hasLineResponseEntries

hasNoLineResponseEntries

getLineResponseCount

getLineResponseAtIndex

addLineResponse

cloneTo

clone