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

Class ResponseType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class ResponseType
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>Response. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe an application-level response to a document.</ccts:Definition><ccts:ObjectClass>Response</ccts:ObjectClass></ccts:Component>
 

Java class for ResponseType complex type.

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

 <complexType name="ResponseType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ReferenceID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ResponseCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Description" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}EffectiveDate" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}EffectiveTime" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Status" maxOccurs="unbounded" 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
ResponseType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addDescription(DescriptionType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addStatus(StatusType elem) Created by ph-jaxb22-plugin -Xph-list-extension
ResponseType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(ResponseType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
List<DescriptionType>	getDescription() <?
DescriptionType	getDescriptionAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getDescriptionCount() Created by ph-jaxb22-plugin -Xph-list-extension
EffectiveDateType	getEffectiveDate() <?
LocalDate	getEffectiveDateValue() Get the value of the contained EffectiveDateType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
EffectiveTimeType	getEffectiveTime() <?
LocalTime	getEffectiveTimeValue() Get the value of the contained EffectiveTimeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
ReferenceIDType	getReferenceID() <?
String	getReferenceIDValue() Get the value of the contained ReferenceIDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
ResponseCodeType	getResponseCode() <?
String	getResponseCodeValue() Get the value of the contained ResponseCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<StatusType>	getStatus() <?
StatusType	getStatusAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getStatusCount() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoStatusEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasStatusEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setDescription(List<DescriptionType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setEffectiveDate(EffectiveDateType value) Sets the value of the effectiveDate property.
EffectiveDateType	setEffectiveDate(LocalDate valueParam) Special setter with value of type LocalDate Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setEffectiveTime(EffectiveTimeType value) Sets the value of the effectiveTime property.
EffectiveTimeType	setEffectiveTime(LocalTime valueParam) Special setter with value of type LocalTime Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setReferenceID(ReferenceIDType value) Sets the value of the referenceID property.
ReferenceIDType	setReferenceID(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setResponseCode(ResponseCodeType value) Sets the value of the responseCode property.
ResponseCodeType	setResponseCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setStatus(List<StatusType> 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

ResponseType

public ResponseType()

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

Method Detail

getReferenceID

@Nullable
public ReferenceIDType getReferenceID()

 <?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>Response. Reference. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for the section (or line) of the document to which this response applies.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Response</ccts:ObjectClass><ccts:PropertyTerm>Reference</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is ReferenceIDType

setReferenceID

public void setReferenceID(@Nullable
                           ReferenceIDType value)

Sets the value of the referenceID property.

Parameters:

value - allowed object is ReferenceIDType

getResponseCode

@Nullable
public ResponseCodeType getResponseCode()

 <?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>Response. Response Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code signifying the type of response.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Response</ccts:ObjectClass><ccts:PropertyTerm>Response Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is ResponseCodeType

setResponseCode

public void setResponseCode(@Nullable
                            ResponseCodeType value)

Sets the value of the responseCode property.

Parameters:

value - allowed object is ResponseCodeType

getDescription

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<DescriptionType> getDescription()

 <?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>Response. Description. Text</ccts:DictionaryEntryName><ccts:Definition>Text describing this response.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Response</ccts:ObjectClass><ccts:PropertyTerm>Description</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

Gets the value of the description 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 description property.

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

    getDescription().add(newItem);
 

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

getEffectiveDate

@Nullable
public EffectiveDateType getEffectiveDate()

 <?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>Response. Effective Date. Date</ccts:DictionaryEntryName><ccts:Definition>The date upon which this response is valid.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Response</ccts:ObjectClass><ccts:PropertyTerm>Effective Date</ccts:PropertyTerm><ccts:RepresentationTerm>Date</ccts:RepresentationTerm><ccts:DataType>Date. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is EffectiveDateType

setEffectiveDate

public void setEffectiveDate(@Nullable
                             EffectiveDateType value)

Sets the value of the effectiveDate property.

Parameters:

value - allowed object is EffectiveDateType

getEffectiveTime

@Nullable
public EffectiveTimeType getEffectiveTime()

 <?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>Response. Effective Time. Time</ccts:DictionaryEntryName><ccts:Definition>The time at which this response is valid.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Response</ccts:ObjectClass><ccts:PropertyTerm>Effective Time</ccts:PropertyTerm><ccts:RepresentationTerm>Time</ccts:RepresentationTerm><ccts:DataType>Time. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is EffectiveTimeType

setEffectiveTime

public void setEffectiveTime(@Nullable
                             EffectiveTimeType value)

Sets the value of the effectiveTime property.

Parameters:

value - allowed object is EffectiveTimeType

getStatus

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<StatusType> getStatus()

 <?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>Response. Status</ccts:DictionaryEntryName><ccts:Definition>A status report associated with this response.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Response</ccts:ObjectClass><ccts:PropertyTerm>Status</ccts:PropertyTerm><ccts:AssociatedObjectClass>Status</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Status</ccts:RepresentationTerm></ccts:Component>
 

Gets the value of the status 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 status property.

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

    getStatus().add(newItem);
 

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

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

setDescription

public void setDescription(@Nullable
                           List<DescriptionType> aList)

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

Parameters:

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

setStatus

public void setStatus(@Nullable
                      List<StatusType> aList)

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

Parameters:

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

hasDescriptionEntries

public boolean hasDescriptionEntries()

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

Returns:

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

hasNoDescriptionEntries

public boolean hasNoDescriptionEntries()

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

Returns:

true if no item is contained, false otherwise.

getDescriptionCount

@Nonnegative
public int getDescriptionCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getDescriptionAtIndex

@Nullable
public DescriptionType getDescriptionAtIndex(@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!

addDescription

public void addDescription(@Nonnull
                           DescriptionType elem)

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

Parameters:

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

hasStatusEntries

public boolean hasStatusEntries()

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

Returns:

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

hasNoStatusEntries

public boolean hasNoStatusEntries()

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

Returns:

true if no item is contained, false otherwise.

getStatusCount

@Nonnegative
public int getStatusCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getStatusAtIndex

@Nullable
public StatusType getStatusAtIndex(@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!

addStatus

public void addStatus(@Nonnull
                      StatusType 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
                    ResponseType 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 ResponseType 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.

setResponseCode

@Nonnull
public ResponseCodeType setResponseCode(@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 ResponseCodeType and never null

setEffectiveDate

@Nonnull
public EffectiveDateType setEffectiveDate(@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 EffectiveDateType and never null

setEffectiveTime

@Nonnull
public EffectiveTimeType setEffectiveTime(@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 EffectiveTimeType and never null

setReferenceID

@Nonnull
public ReferenceIDType setReferenceID(@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 ReferenceIDType and never null

getReferenceIDValue

@Nullable
public String getReferenceIDValue()

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

Returns:

Either the value of the contained ReferenceIDType object or null

getResponseCodeValue

@Nullable
public String getResponseCodeValue()

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

Returns:

Either the value of the contained ResponseCodeType object or null

getEffectiveDateValue

@Nullable
public LocalDate getEffectiveDateValue()

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

Returns:

Either the value of the contained EffectiveDateType object or null

getEffectiveTimeValue

@Nullable
public LocalTime getEffectiveTimeValue()

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

Returns:

Either the value of the contained EffectiveTimeType object or null