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

Class ExchangeRateType

java.lang.Object

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

public class ExchangeRateType
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>Exchange Rate. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to define an exchange rate.</ccts:Definition>
                <ccts:ObjectClass>Exchange Rate</ccts:ObjectClass>
             </ccts:Component>
 

Java class for ExchangeRateType complex type.

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

 <complexType name="ExchangeRateType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}SourceCurrencyCode"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}SourceCurrencyBaseRate" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TargetCurrencyCode"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TargetCurrencyBaseRate" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ExchangeMarketID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}CalculationRate" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}MathematicOperatorCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Date" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ForeignExchangeContract" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected CalculationRateType	calculationRate
protected DateType	date
protected ExchangeMarketIDType	exchangeMarketID
protected ContractType	foreignExchangeContract
protected MathematicOperatorCodeType	mathematicOperatorCode
protected SourceCurrencyBaseRateType	sourceCurrencyBaseRate
protected SourceCurrencyCodeType	sourceCurrencyCode
protected TargetCurrencyBaseRateType	targetCurrencyBaseRate
protected TargetCurrencyCodeType	targetCurrencyCode

Constructor Summary

Constructors

Constructor and Description
ExchangeRateType()

Method Summary

Modifier and Type	Method and Description
CalculationRateType	getCalculationRate() <?
DateType	getDate() <?
ExchangeMarketIDType	getExchangeMarketID() <?
ContractType	getForeignExchangeContract() <?
MathematicOperatorCodeType	getMathematicOperatorCode() <?
SourceCurrencyBaseRateType	getSourceCurrencyBaseRate() <?
SourceCurrencyCodeType	getSourceCurrencyCode() <?
TargetCurrencyBaseRateType	getTargetCurrencyBaseRate() <?
TargetCurrencyCodeType	getTargetCurrencyCode() <?
void	setCalculationRate(CalculationRateType value) Sets the value of the calculationRate property.
void	setDate(DateType value) Sets the value of the date property.
void	setExchangeMarketID(ExchangeMarketIDType value) Sets the value of the exchangeMarketID property.
void	setForeignExchangeContract(ContractType value) Sets the value of the foreignExchangeContract property.
void	setMathematicOperatorCode(MathematicOperatorCodeType value) Sets the value of the mathematicOperatorCode property.
void	setSourceCurrencyBaseRate(SourceCurrencyBaseRateType value) Sets the value of the sourceCurrencyBaseRate property.
void	setSourceCurrencyCode(SourceCurrencyCodeType value) Sets the value of the sourceCurrencyCode property.
void	setTargetCurrencyBaseRate(TargetCurrencyBaseRateType value) Sets the value of the targetCurrencyBaseRate property.
void	setTargetCurrencyCode(TargetCurrencyCodeType value) Sets the value of the targetCurrencyCode property.

Methods inherited from class java.lang.Object

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

Field Detail

sourceCurrencyCode

protected SourceCurrencyCodeType sourceCurrencyCode

sourceCurrencyBaseRate

protected SourceCurrencyBaseRateType sourceCurrencyBaseRate

targetCurrencyCode

protected TargetCurrencyCodeType targetCurrencyCode

targetCurrencyBaseRate

protected TargetCurrencyBaseRateType targetCurrencyBaseRate

exchangeMarketID

protected ExchangeMarketIDType exchangeMarketID

calculationRate

protected CalculationRateType calculationRate

mathematicOperatorCode

protected MathematicOperatorCodeType mathematicOperatorCode

date

protected DateType date

foreignExchangeContract

protected ContractType foreignExchangeContract

Constructor Detail

ExchangeRateType

public ExchangeRateType()

Method Detail

getSourceCurrencyCode

public SourceCurrencyCodeType getSourceCurrencyCode()

 <?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>Exchange Rate. Source_ Currency Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>The reference currency for this exchange rate; the currency from which the exchange is being made.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Exchange Rate</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Source</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Currency Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataTypeQualifier>Currency</ccts:DataTypeQualifier>
                      <ccts:DataType>Currency_ Code. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is SourceCurrencyCodeType

setSourceCurrencyCode

public void setSourceCurrencyCode(SourceCurrencyCodeType value)

Sets the value of the sourceCurrencyCode property.

Parameters:

value - allowed object is SourceCurrencyCodeType

getSourceCurrencyBaseRate

public SourceCurrencyBaseRateType getSourceCurrencyBaseRate()

 <?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>Exchange Rate. Source_ Currency Base Rate. Rate</ccts:DictionaryEntryName>
                      <ccts:Definition>In the case of a source currency with denominations of small value, the unit base.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Exchange Rate</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Source</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Currency Base Rate</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Rate</ccts:RepresentationTerm>
                      <ccts:DataType>Rate. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is SourceCurrencyBaseRateType

setSourceCurrencyBaseRate

public void setSourceCurrencyBaseRate(SourceCurrencyBaseRateType value)

Sets the value of the sourceCurrencyBaseRate property.

Parameters:

value - allowed object is SourceCurrencyBaseRateType

getTargetCurrencyCode

public TargetCurrencyCodeType getTargetCurrencyCode()

 <?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>Exchange Rate. Target_ Currency Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>The target currency for this exchange rate; the currency to which the exchange is being made.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Exchange Rate</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Target</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Currency Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataTypeQualifier>Currency</ccts:DataTypeQualifier>
                      <ccts:DataType>Currency_ Code. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is TargetCurrencyCodeType

setTargetCurrencyCode

public void setTargetCurrencyCode(TargetCurrencyCodeType value)

Sets the value of the targetCurrencyCode property.

Parameters:

value - allowed object is TargetCurrencyCodeType

getTargetCurrencyBaseRate

public TargetCurrencyBaseRateType getTargetCurrencyBaseRate()

 <?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>Exchange Rate. Target_ Currency Base Rate. Rate</ccts:DictionaryEntryName>
                      <ccts:Definition>In the case of a target currency with denominations of small value, the unit base.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Exchange Rate</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Target</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Currency Base Rate</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Rate</ccts:RepresentationTerm>
                      <ccts:DataType>Rate. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is TargetCurrencyBaseRateType

setTargetCurrencyBaseRate

public void setTargetCurrencyBaseRate(TargetCurrencyBaseRateType value)

Sets the value of the targetCurrencyBaseRate property.

Parameters:

value - allowed object is TargetCurrencyBaseRateType

getExchangeMarketID

public ExchangeMarketIDType getExchangeMarketID()

 <?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>Exchange Rate. Exchange Market Identifier. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for the currency exchange market used as the source of this exchange rate.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Exchange Rate</ccts:ObjectClass>
                      <ccts:PropertyTerm>Exchange Market Identifier</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is ExchangeMarketIDType

setExchangeMarketID

public void setExchangeMarketID(ExchangeMarketIDType value)

Sets the value of the exchangeMarketID property.

Parameters:

value - allowed object is ExchangeMarketIDType

getCalculationRate

public CalculationRateType getCalculationRate()

 <?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>Exchange Rate. Calculation Rate. Rate</ccts:DictionaryEntryName>
                      <ccts:Definition>The factor applied to the source currency to calculate the target currency.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Exchange Rate</ccts:ObjectClass>
                      <ccts:PropertyTerm>Calculation Rate</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Rate</ccts:RepresentationTerm>
                      <ccts:DataType>Rate. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is CalculationRateType

setCalculationRate

public void setCalculationRate(CalculationRateType value)

Sets the value of the calculationRate property.

Parameters:

value - allowed object is CalculationRateType

getMathematicOperatorCode

public MathematicOperatorCodeType getMathematicOperatorCode()

 <?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>Exchange Rate. Mathematic Operator Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>A code signifying whether the calculation rate is a multiplier or a divisor.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Exchange Rate</ccts:ObjectClass>
                      <ccts:PropertyTerm>Mathematic Operator Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataTypeQualifier>Operator</ccts:DataTypeQualifier>
                      <ccts:DataType>Operator_ Code. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is MathematicOperatorCodeType

setMathematicOperatorCode

public void setMathematicOperatorCode(MathematicOperatorCodeType value)

Sets the value of the mathematicOperatorCode property.

Parameters:

value - allowed object is MathematicOperatorCodeType

getDate

public DateType getDate()

 <?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>Exchange Rate. Date</ccts:DictionaryEntryName>
                      <ccts:Definition>The date on which the exchange rate was established.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Exchange Rate</ccts:ObjectClass>
                      <ccts:PropertyTerm>Date</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Date</ccts:RepresentationTerm>
                      <ccts:DataType>Date. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is DateType

setDate

public void setDate(DateType value)

Sets the value of the date property.

Parameters:

value - allowed object is DateType

getForeignExchangeContract

public ContractType getForeignExchangeContract()

 <?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>Exchange Rate. Foreign Exchange_ Contract. Contract</ccts:DictionaryEntryName>
                      <ccts:Definition>A contract for foreign exchange.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Exchange Rate</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Foreign Exchange</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Contract</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Contract</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Contract</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is ContractType

setForeignExchangeContract

public void setForeignExchangeContract(ContractType value)

Sets the value of the foreignExchangeContract property.

Parameters:

value - allowed object is ContractType