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

Class PriceType

java.lang.Object

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

public class PriceType
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>Price. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to describe a price, expressed in a data structure containing multiple properties (compare with UnstructuredPrice).</ccts:Definition>
                <ccts:ObjectClass>Price</ccts:ObjectClass>
             </ccts:Component>
 

Java class for PriceType complex type.

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

 <complexType name="PriceType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}PriceAmount"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}BaseQuantity" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}PriceChangeReason" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}PriceTypeCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}PriceType" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}OrderableUnitFactorRate" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ValidityPeriod" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}PriceList" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}AllowanceCharge" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}PricingExchangeRate" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AllowanceChargeType>	allowanceCharge
protected BaseQuantityType	baseQuantity
protected OrderableUnitFactorRateType	orderableUnitFactorRate
protected PriceAmountType	priceAmount
protected List<PriceChangeReasonType>	priceChangeReason
protected PriceListType	priceList
protected PriceTypeType	priceType
protected PriceTypeCodeType	priceTypeCode
protected ExchangeRateType	pricingExchangeRate
protected List<PeriodType>	validityPeriod

Constructor Summary

Constructors

Constructor and Description
PriceType()

Method Summary

Modifier and Type	Method and Description
List<AllowanceChargeType>	getAllowanceCharge() <?
BaseQuantityType	getBaseQuantity() <?
OrderableUnitFactorRateType	getOrderableUnitFactorRate() <?
PriceAmountType	getPriceAmount() <?
List<PriceChangeReasonType>	getPriceChangeReason() <?
PriceListType	getPriceList() <?
PriceTypeType	getPriceType() <?
PriceTypeCodeType	getPriceTypeCode() <?
ExchangeRateType	getPricingExchangeRate() <?
List<PeriodType>	getValidityPeriod() <?
void	setBaseQuantity(BaseQuantityType value) Sets the value of the baseQuantity property.
void	setOrderableUnitFactorRate(OrderableUnitFactorRateType value) Sets the value of the orderableUnitFactorRate property.
void	setPriceAmount(PriceAmountType value) Sets the value of the priceAmount property.
void	setPriceList(PriceListType value) Sets the value of the priceList property.
void	setPriceType(PriceTypeType value) Sets the value of the priceType property.
void	setPriceTypeCode(PriceTypeCodeType value) Sets the value of the priceTypeCode property.
void	setPricingExchangeRate(ExchangeRateType value) Sets the value of the pricingExchangeRate property.

Methods inherited from class java.lang.Object

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

Field Detail

priceAmount

protected PriceAmountType priceAmount

baseQuantity

protected BaseQuantityType baseQuantity

priceChangeReason

protected List<PriceChangeReasonType> priceChangeReason

priceTypeCode

protected PriceTypeCodeType priceTypeCode

priceType

protected PriceTypeType priceType

orderableUnitFactorRate

protected OrderableUnitFactorRateType orderableUnitFactorRate

validityPeriod

protected List<PeriodType> validityPeriod

priceList

protected PriceListType priceList

allowanceCharge

protected List<AllowanceChargeType> allowanceCharge

pricingExchangeRate

protected ExchangeRateType pricingExchangeRate

Constructor Detail

PriceType

public PriceType()

Method Detail

getPriceAmount

public PriceAmountType getPriceAmount()

 <?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>Price. Price Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The amount of the price.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Price</ccts:ObjectClass>
                      <ccts:PropertyTerm>Price Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                      <ccts:AlternativeBusinessTerms>unit price</ccts:AlternativeBusinessTerms>
                      <ccts:Examples>23.45</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is PriceAmountType

setPriceAmount

public void setPriceAmount(PriceAmountType value)

Sets the value of the priceAmount property.

Parameters:

value - allowed object is PriceAmountType

getBaseQuantity

public BaseQuantityType getBaseQuantity()

 <?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>Price. Base_ Quantity. Quantity</ccts:DictionaryEntryName>
                      <ccts:Definition>The quantity at which this price applies.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Price</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Base</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Quantity</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm>
                      <ccts:DataType>Quantity. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is BaseQuantityType

setBaseQuantity

public void setBaseQuantity(BaseQuantityType value)

Sets the value of the baseQuantity property.

Parameters:

value - allowed object is BaseQuantityType

getPriceChangeReason

public List<PriceChangeReasonType> getPriceChangeReason()

 <?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>Price. Price Change_ Reason. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>A reason for a price change.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Price</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Price Change</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Reason</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:Examples>Clearance of old stock , New contract applies </ccts:Examples>
                   </ccts:Component>
 

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

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

    getPriceChangeReason().add(newItem);
 

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

getPriceTypeCode

public PriceTypeCodeType getPriceTypeCode()

 <?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>Price. Price Type Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>The type of price, expressed as a code.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Price</ccts:ObjectClass>
                      <ccts:PropertyTerm>Price Type Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is PriceTypeCodeType

setPriceTypeCode

public void setPriceTypeCode(PriceTypeCodeType value)

Sets the value of the priceTypeCode property.

Parameters:

value - allowed object is PriceTypeCodeType

getPriceType

public PriceTypeType getPriceType()

 <?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>Price. Price Type. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>The type of price, expressed as text.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Price</ccts:ObjectClass>
                      <ccts:PropertyTerm>Price Type</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:Examples>retail, wholesale, discount, contract</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is PriceTypeType

setPriceType

public void setPriceType(PriceTypeType value)

Sets the value of the priceType property.

Parameters:

value - allowed object is PriceTypeType

getOrderableUnitFactorRate

public OrderableUnitFactorRateType getOrderableUnitFactorRate()

 <?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>Price. Orderable Unit Factor. Rate</ccts:DictionaryEntryName>
                      <ccts:Definition>The factor by which the base price unit can be converted to the orderable unit.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Price</ccts:ObjectClass>
                      <ccts:PropertyTerm>Orderable Unit Factor</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Rate</ccts:RepresentationTerm>
                      <ccts:DataType>Rate. Type</ccts:DataType>
                      <ccts:Examples>Nails are priced by weight but ordered by quantity. So this would say how many nails per kilo</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is OrderableUnitFactorRateType

setOrderableUnitFactorRate

public void setOrderableUnitFactorRate(OrderableUnitFactorRateType value)

Sets the value of the orderableUnitFactorRate property.

Parameters:

value - allowed object is OrderableUnitFactorRateType

getValidityPeriod

public List<PeriodType> getValidityPeriod()

 <?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>Price. Validity_ Period. Period</ccts:DictionaryEntryName>
                      <ccts:Definition>A period during which this price is valid.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Price</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Validity</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Period</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Period</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getValidityPeriod().add(newItem);
 

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

getPriceList

public PriceListType getPriceList()

 <?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>Price. Price List</ccts:DictionaryEntryName>
                      <ccts:Definition>Information about a price list applicable to this price.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Price</ccts:ObjectClass>
                      <ccts:PropertyTerm>Price List</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Price List</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Price List</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is PriceListType

setPriceList

public void setPriceList(PriceListType value)

Sets the value of the priceList property.

Parameters:

value - allowed object is PriceListType

getAllowanceCharge

public List<AllowanceChargeType> getAllowanceCharge()

 <?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>Price. Allowance Charge</ccts:DictionaryEntryName>
                      <ccts:Definition>An allowance or charge associated with this price.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Price</ccts:ObjectClass>
                      <ccts:PropertyTerm>Allowance Charge</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Allowance Charge</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Allowance Charge</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getAllowanceCharge().add(newItem);
 

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

getPricingExchangeRate

public ExchangeRateType getPricingExchangeRate()

 <?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>Price. Pricing_ Exchange Rate. Exchange Rate</ccts:DictionaryEntryName>
                      <ccts:Definition>The exchange rate applicable to this price, if it differs from the exchange rate applicable to the document as a whole.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Price</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Pricing</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Exchange Rate</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Exchange Rate</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Exchange Rate</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is ExchangeRateType

setPricingExchangeRate

public void setPricingExchangeRate(ExchangeRateType value)

Sets the value of the pricingExchangeRate property.

Parameters:

value - allowed object is ExchangeRateType