oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2.DocumentResponseType Maven / Gradle / Ivy
package oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
import com.phloc.commons.annotations.ReturnsMutableObject;
import com.phloc.commons.equals.EqualsUtils;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.string.ToStringGenerator;
/**
*
*
* <?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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ABIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Response. Details</ccts:DictionaryEntryName><ccts:Definition>Information about responses to a document (at the application level).</ccts:Definition><ccts:ObjectClass>Document Response</ccts:ObjectClass></ccts:Component>
*
*
*
* Java class for DocumentResponseType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <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"/>
* <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>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "DocumentResponseType", propOrder = {
"response",
"documentReference",
"issuerParty",
"recipientParty",
"lineResponse"
})
public class DocumentResponseType implements Serializable
{
@XmlElement(name = "Response", required = true)
private ResponseType response;
@XmlElement(name = "DocumentReference", required = true)
private DocumentReferenceType documentReference;
@XmlElement(name = "IssuerParty")
private PartyType issuerParty;
@XmlElement(name = "RecipientParty")
private PartyType recipientParty;
@XmlElement(name = "LineResponse")
private List lineResponse;
/**
* Default constructor
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
*/
public DocumentResponseType() {
}
/**
*
*
* <?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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Response. Response</ccts:DictionaryEntryName><ccts:Definition>The response to the document.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Document Response</ccts:ObjectClass><ccts:PropertyTerm>Response</ccts:PropertyTerm><ccts:AssociatedObjectClass>Response</ccts:AssociatedObjectClass></ccts:Component>
*
*
*
* @return
* possible object is
* {@link ResponseType }
*
*/
@Nullable
public ResponseType getResponse() {
return response;
}
/**
* Sets the value of the response property.
*
* @param value
* allowed object is
* {@link ResponseType }
*
*/
public void setResponse(
@Nullable
ResponseType value) {
this.response = value;
}
/**
*
*
* <?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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Response. Document Reference</ccts:DictionaryEntryName><ccts:Definition>An association to Document Reference.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Document Response</ccts:ObjectClass><ccts:PropertyTerm>Document Reference</ccts:PropertyTerm><ccts:AssociatedObjectClass>Document Reference</ccts:AssociatedObjectClass></ccts:Component>
*
*
*
* @return
* possible object is
* {@link DocumentReferenceType }
*
*/
@Nullable
public DocumentReferenceType getDocumentReference() {
return documentReference;
}
/**
* Sets the value of the documentReference property.
*
* @param value
* allowed object is
* {@link DocumentReferenceType }
*
*/
public void setDocumentReference(
@Nullable
DocumentReferenceType value) {
this.documentReference = value;
}
/**
*
*
* <?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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" 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 who issued a 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:Component>
*
*
*
* @return
* possible object is
* {@link PartyType }
*
*/
@Nullable
public PartyType getIssuerParty() {
return issuerParty;
}
/**
* Sets the value of the issuerParty property.
*
* @param value
* allowed object is
* {@link PartyType }
*
*/
public void setIssuerParty(
@Nullable
PartyType value) {
this.issuerParty = value;
}
/**
*
*
* <?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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" 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 whom 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:Component>
*
*
*
* @return
* possible object is
* {@link PartyType }
*
*/
@Nullable
public PartyType getRecipientParty() {
return recipientParty;
}
/**
* Sets the value of the recipientParty property.
*
* @param value
* allowed object is
* {@link PartyType }
*
*/
public void setRecipientParty(
@Nullable
PartyType value) {
this.recipientParty = value;
}
/**
*
*
* <?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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Document Response. Line Response</ccts:DictionaryEntryName><ccts:Definition>Response to various lines 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:Component>
*
* 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 set method for the lineResponse property.
*
*
* For example, to add a new item, do as follows:
*
* getLineResponse().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link LineResponseType }
*
*
*/
@Nonnull
@ReturnsMutableObject(reason = "JAXB implementation style")
public List getLineResponse() {
if (lineResponse == null) {
lineResponse = new ArrayList();
}
return this.lineResponse;
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-equalshashcode
*
*/
@Override
public boolean equals(final Object o) {
if (o == this) {
return true;
}
if ((o == null)||(!getClass().equals(o.getClass()))) {
return false;
}
final DocumentResponseType rhs = ((DocumentResponseType) o);
if (!EqualsUtils.equals(response, rhs.response)) {
return false;
}
if (!EqualsUtils.equals(documentReference, rhs.documentReference)) {
return false;
}
if (!EqualsUtils.equals(issuerParty, rhs.issuerParty)) {
return false;
}
if (!EqualsUtils.equals(recipientParty, rhs.recipientParty)) {
return false;
}
if (!EqualsUtils.equals(lineResponse, rhs.lineResponse)) {
return false;
}
return true;
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-equalshashcode
*
*/
@Override
public int hashCode() {
return new HashCodeGenerator(this).append(response).append(documentReference).append(issuerParty).append(recipientParty).append(lineResponse).getHashCode();
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-tostring
*
*/
@Override
public String toString() {
return new ToStringGenerator(this).append("response", response).append("documentReference", documentReference).append("issuerParty", issuerParty).append("recipientParty", recipientParty).append("lineResponse", lineResponse).toString();
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @param aList
* The new list member to set. May be null.
*/
public void setLineResponse(
@Nullable
final List aList) {
lineResponse = aList;
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @return
* true if at least one item is contained, false otherwise.
*/
public boolean hasLineResponseEntries() {
return (!getLineResponse().isEmpty());
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @return
* true if no item is contained, false otherwise.
*/
public boolean hasNoLineResponseEntries() {
return getLineResponse().isEmpty();
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @return
* The number of contained elements. Always ≥ 0.
*/
@Nonnegative
public int getLineResponseCount() {
return getLineResponse().size();
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @param index
* The index to retrieve
* @return
* The element at the specified index. May be null
* @throws ArrayIndexOutOfBoundsException
* if the index is invalid!
*/
@Nullable
public LineResponseType getLineResponseAtIndex(
@Nonnegative
final int index) {
return getLineResponse().get(index);
}
}