oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2

Class ResponseType

java.lang.Object

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

public class ResponseType
extends Object

 <?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>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<DescriptionType>	description
protected EffectiveDateType	effectiveDate
protected EffectiveTimeType	effectiveTime
protected ReferenceIDType	referenceID
protected ResponseCodeType	responseCode
protected List<StatusType>	status

Constructor Summary

Constructors

Constructor and Description
ResponseType()

Method Summary

Modifier and Type	Method and Description
List<DescriptionType>	getDescription() <?
EffectiveDateType	getEffectiveDate() <?
EffectiveTimeType	getEffectiveTime() <?
ReferenceIDType	getReferenceID() <?
ResponseCodeType	getResponseCode() <?
List<StatusType>	getStatus() <?
void	setEffectiveDate(EffectiveDateType value) Sets the value of the effectiveDate property.
void	setEffectiveTime(EffectiveTimeType value) Sets the value of the effectiveTime property.
void	setReferenceID(ReferenceIDType value) Sets the value of the referenceID property.
void	setResponseCode(ResponseCodeType value) Sets the value of the responseCode property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

referenceID

protected ReferenceIDType referenceID

responseCode

protected ResponseCodeType responseCode

description

protected List<DescriptionType> description

effectiveDate

protected EffectiveDateType effectiveDate

effectiveTime

protected EffectiveTimeType effectiveTime

status

protected List<StatusType> status

Constructor Detail

ResponseType

public ResponseType()

Method Detail

getReferenceID

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(ReferenceIDType value)

Sets the value of the referenceID property.

Parameters:

value - allowed object is ReferenceIDType

getResponseCode

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(ResponseCodeType value)

Sets the value of the responseCode property.

Parameters:

value - allowed object is ResponseCodeType

getDescription

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

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(EffectiveDateType value)

Sets the value of the effectiveDate property.

Parameters:

value - allowed object is EffectiveDateType

getEffectiveTime

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(EffectiveTimeType value)

Sets the value of the effectiveTime property.

Parameters:

value - allowed object is EffectiveTimeType

getStatus

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