org.ota.hotel
Class Amount

java.lang.Object
  org.ota.hotel.Amount

Direct Known Subclasses:

Rate.RateInner

public class Amount
extends java.lang.Object

Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="AmountType">
   <xs:sequence>
     <xs:element type="ns:TotalType" name="Base" minOccurs="0"/>
     <xs:element name="AdditionalGuestAmounts" minOccurs="0">
       <!-- Reference to inner class AdditionalGuestAmounts -->
     </xs:element>
     <xs:element type="ns:FeesType" name="Fees" minOccurs="0"/>
     <xs:element type="ns:CancelPenaltiesType" name="CancelPolicies" minOccurs="0"/>
     <xs:element type="ns:RequiredPaymentsType" name="PaymentPolicies" minOccurs="0"/>
     <xs:element name="Discount" minOccurs="0" maxOccurs="5">
       <!-- Reference to inner class Discount -->
     </xs:element>
     <xs:element type="ns:TotalType" name="Total" minOccurs="0"/>
     <xs:element type="ns:ParagraphType" name="RateDescription" minOccurs="0"/>
     <xs:element type="ns:HotelAdditionalChargesType" name="AdditionalCharges" minOccurs="0"/>
   </xs:sequence>
   <xs:attributeGroup ref="ns:EffectiveExpireOptionalDateGroup"/>
   <xs:attributeGroup ref="ns:AgeQualifyingGroup"/>
   <xs:attribute type="xs:boolean" use="optional" name="GuaranteedInd"/>
   <xs:attribute type="xs:int" use="optional" name="NumberOfUnits"/>
   <xs:attribute type="ns:TimeUnitType" use="optional" name="RateTimeUnit"/>
   <xs:attribute type="xs:string" use="optional" name="UnitMultiplier"/>
   <xs:attribute type="xs:string" use="optional" name="MinGuestApplicable"/>
   <xs:attribute type="xs:string" use="optional" name="MaxGuestApplicable"/>
   <xs:attribute type="xs:int" use="optional" name="MinLOS"/>
   <xs:attribute type="xs:int" use="optional" name="MaxLOS"/>
   <xs:attribute type="ns:DayOfWeekType" use="optional" name="StayOverDate"/>
   <xs:attribute type="xs:boolean" use="optional" name="AlternateCurrencyInd"/>
 </xs:complexType>
 

Nested Class Summary

static class	Amount.AdditionalGuestAmounts A collection of charges that apply to for additional occupants, guests or service users (over and above the rate's MaxGuest Applicable) Schema fragment(s) for this class:
static class	Amount.Discount Discount percentage and/or Amount, code and textual reason for discount Schema fragment(s) for this class:

Constructor Summary

Amount()

Method Summary

void	addDiscount(Amount.Discount item) Add a 'Discount' element item.
void	clearDiscounts() Remove all 'Discount' element items.
HotelAdditionalCharges	getAdditionalCharges() Get the 'AdditionalCharges' element value.
Amount.AdditionalGuestAmounts	getAdditionalGuestAmounts() Get the 'AdditionalGuestAmounts' element value.
AgeQualifyingGroup	getAgeQualifyingGroup() Get the 'AgeQualifyingGroup' attributeGroup value.
java.lang.Boolean	getAlternateCurrencyInd() Get the 'AlternateCurrencyInd' attribute value.
Total	getBase() Get the 'Base' element value.
CancelPenalties	getCancelPolicies() Get the 'CancelPolicies' element value.
Amount.Discount	getDiscount(int index) Get 'Discount' element item by position.
java.util.List<Amount.Discount>	getDiscounts() Get the list of 'Discount' element items.
EffectiveExpireOptionalDateGroup	getEffectiveExpireOptionalDateGroup() Get the 'EffectiveExpireOptionalDateGroup' attributeGroup value.
Fees	getFees() Get the 'Fees' element value.
java.lang.Boolean	getGuaranteedInd() Get the 'GuaranteedInd' attribute value.
java.lang.String	getMaxGuestApplicable() Get the 'MaxGuestApplicable' attribute value.
java.lang.Integer	getMaxLOS() Get the 'MaxLOS' attribute value.
java.lang.String	getMinGuestApplicable() Get the 'MinGuestApplicable' attribute value.
java.lang.Integer	getMinLOS() Get the 'MinLOS' attribute value.
java.lang.Integer	getNumberOfUnits() Get the 'NumberOfUnits' attribute value.
RequiredPayments	getPaymentPolicies() Get the 'PaymentPolicies' element value.
Paragraph	getRateDescription() Get the 'RateDescription' element value.
TimeUnit	getRateTimeUnit() Get the 'RateTimeUnit' attribute value.
DayOfWeek	getStayOverDate() Get the 'StayOverDate' attribute value.
Total	getTotal() Get the 'Total' element value.
java.lang.String	getUnitMultiplier() Get the 'UnitMultiplier' attribute value.
void	setAdditionalCharges(HotelAdditionalCharges additionalCharges) Set the 'AdditionalCharges' element value.
void	setAdditionalGuestAmounts(Amount.AdditionalGuestAmounts additionalGuestAmounts) Set the 'AdditionalGuestAmounts' element value.
void	setAgeQualifyingGroup(AgeQualifyingGroup ageQualifyingGroup) Set the 'AgeQualifyingGroup' attributeGroup value.
void	setAlternateCurrencyInd(java.lang.Boolean alternateCurrencyInd) Set the 'AlternateCurrencyInd' attribute value.
void	setBase(Total base) Set the 'Base' element value.
void	setCancelPolicies(CancelPenalties cancelPolicies) Set the 'CancelPolicies' element value.
void	setDiscounts(java.util.List<Amount.Discount> list) Set the list of 'Discount' element items.
void	setEffectiveExpireOptionalDateGroup(EffectiveExpireOptionalDateGroup effectiveExpireOptionalDateGroup) Set the 'EffectiveExpireOptionalDateGroup' attributeGroup value.
void	setFees(Fees fees) Set the 'Fees' element value.
void	setGuaranteedInd(java.lang.Boolean guaranteedInd) Set the 'GuaranteedInd' attribute value.
void	setMaxGuestApplicable(java.lang.String maxGuestApplicable) Set the 'MaxGuestApplicable' attribute value.
void	setMaxLOS(java.lang.Integer maxLOS) Set the 'MaxLOS' attribute value.
void	setMinGuestApplicable(java.lang.String minGuestApplicable) Set the 'MinGuestApplicable' attribute value.
void	setMinLOS(java.lang.Integer minLOS) Set the 'MinLOS' attribute value.
void	setNumberOfUnits(java.lang.Integer numberOfUnits) Set the 'NumberOfUnits' attribute value.
void	setPaymentPolicies(RequiredPayments paymentPolicies) Set the 'PaymentPolicies' element value.
void	setRateDescription(Paragraph rateDescription) Set the 'RateDescription' element value.
void	setRateTimeUnit(TimeUnit rateTimeUnit) Set the 'RateTimeUnit' attribute value.
void	setStayOverDate(DayOfWeek stayOverDate) Set the 'StayOverDate' attribute value.
void	setTotal(Total total) Set the 'Total' element value.
void	setUnitMultiplier(java.lang.String unitMultiplier) Set the 'UnitMultiplier' attribute value.
int	sizeDiscounts() Get the number of 'Discount' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

Amount

public Amount()

Method Detail

getBase

public Total getBase()

Get the 'Base' element value. The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements.

Returns:

value

setBase

public void setBase(Total base)

Set the 'Base' element value. The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements.

Parameters:

base -

getAdditionalGuestAmounts

public Amount.AdditionalGuestAmounts getAdditionalGuestAmounts()

Get the 'AdditionalGuestAmounts' element value.

Returns:

value

setAdditionalGuestAmounts

public void setAdditionalGuestAmounts(Amount.AdditionalGuestAmounts additionalGuestAmounts)

Set the 'AdditionalGuestAmounts' element value.

Parameters:

additionalGuestAmounts -

getFees

public Fees getFees()

Get the 'Fees' element value. A collection of Fees.

Returns:

value

setFees

public void setFees(Fees fees)

Set the 'Fees' element value. A collection of Fees.

Parameters:

fees -

getCancelPolicies

public CancelPenalties getCancelPolicies()

Get the 'CancelPolicies' element value. A collection of Cancellation Policies

Returns:

value

setCancelPolicies

public void setCancelPolicies(CancelPenalties cancelPolicies)

Set the 'CancelPolicies' element value. A collection of Cancellation Policies

Parameters:

cancelPolicies -

getPaymentPolicies

public RequiredPayments getPaymentPolicies()

Get the 'PaymentPolicies' element value. A collection of Payment Policies.

Returns:

value

setPaymentPolicies

public void setPaymentPolicies(RequiredPayments paymentPolicies)

Set the 'PaymentPolicies' element value. A collection of Payment Policies.

Parameters:

paymentPolicies -

getDiscounts

public java.util.List<Amount.Discount> getDiscounts()

Get the list of 'Discount' element items.

Returns:

list

setDiscounts

public void setDiscounts(java.util.List<Amount.Discount> list)

Set the list of 'Discount' element items.

Parameters:

list -

sizeDiscounts

public int sizeDiscounts()

Get the number of 'Discount' element items.

Returns:

count

addDiscount

public void addDiscount(Amount.Discount item)

Add a 'Discount' element item.

Parameters:

item -

getDiscount

public Amount.Discount getDiscount(int index)

Get 'Discount' element item by position.

Parameters:

index -

Returns:

item

clearDiscounts

public void clearDiscounts()

Remove all 'Discount' element items.

getTotal

public Total getTotal()

Get the 'Total' element value. The total amount charged for this rate including additional occupant amounts and fees.

Returns:

value

setTotal

public void setTotal(Total total)

Set the 'Total' element value. The total amount charged for this rate including additional occupant amounts and fees.

Parameters:

total -

getRateDescription

public Paragraph getRateDescription()

Get the 'RateDescription' element value. Description of the rate associated with the various monetary amounts and policies.

Returns:

value

setRateDescription

public void setRateDescription(Paragraph rateDescription)

Set the 'RateDescription' element value. Description of the rate associated with the various monetary amounts and policies.

Parameters:

rateDescription -

getAdditionalCharges

public HotelAdditionalCharges getAdditionalCharges()

Get the 'AdditionalCharges' element value. Collection of additional charges.

Returns:

value

setAdditionalCharges

public void setAdditionalCharges(HotelAdditionalCharges additionalCharges)

Set the 'AdditionalCharges' element value. Collection of additional charges.

Parameters:

additionalCharges -

getEffectiveExpireOptionalDateGroup

public EffectiveExpireOptionalDateGroup getEffectiveExpireOptionalDateGroup()

Get the 'EffectiveExpireOptionalDateGroup' attributeGroup value. The effective date range for a charge.

Returns:

value

setEffectiveExpireOptionalDateGroup

public void setEffectiveExpireOptionalDateGroup(EffectiveExpireOptionalDateGroup effectiveExpireOptionalDateGroup)

Set the 'EffectiveExpireOptionalDateGroup' attributeGroup value. The effective date range for a charge.

Parameters:

effectiveExpireOptionalDateGroup -

getAgeQualifyingGroup

public AgeQualifyingGroup getAgeQualifyingGroup()

Get the 'AgeQualifyingGroup' attributeGroup value.

Returns:

value

setAgeQualifyingGroup

public void setAgeQualifyingGroup(AgeQualifyingGroup ageQualifyingGroup)

Set the 'AgeQualifyingGroup' attributeGroup value.

Parameters:

ageQualifyingGroup -

getGuaranteedInd

public java.lang.Boolean getGuaranteedInd()

Get the 'GuaranteedInd' attribute value.

Returns:

value

setGuaranteedInd

public void setGuaranteedInd(java.lang.Boolean guaranteedInd)

Set the 'GuaranteedInd' attribute value.

Parameters:

guaranteedInd -

getNumberOfUnits

public java.lang.Integer getNumberOfUnits()

Get the 'NumberOfUnits' attribute value.

Returns:

value

setNumberOfUnits

public void setNumberOfUnits(java.lang.Integer numberOfUnits)

Set the 'NumberOfUnits' attribute value.

Parameters:

numberOfUnits -

getRateTimeUnit

public TimeUnit getRateTimeUnit()

Get the 'RateTimeUnit' attribute value. Indicates the time unit for the rate.

Returns:

value

setRateTimeUnit

public void setRateTimeUnit(TimeUnit rateTimeUnit)

Set the 'RateTimeUnit' attribute value. Indicates the time unit for the rate.

Parameters:

rateTimeUnit -

getUnitMultiplier

public java.lang.String getUnitMultiplier()

Get the 'UnitMultiplier' attribute value. Indicates the number of rate time units such as "3 Days".

Returns:

value

setUnitMultiplier

public void setUnitMultiplier(java.lang.String unitMultiplier)

Set the 'UnitMultiplier' attribute value. Indicates the number of rate time units such as "3 Days".

Parameters:

unitMultiplier -

getMinGuestApplicable

public java.lang.String getMinGuestApplicable()

Get the 'MinGuestApplicable' attribute value. Indicates the minimum number of guests at this rate.

Returns:

value

setMinGuestApplicable

public void setMinGuestApplicable(java.lang.String minGuestApplicable)

Set the 'MinGuestApplicable' attribute value. Indicates the minimum number of guests at this rate.

Parameters:

minGuestApplicable -

getMaxGuestApplicable

public java.lang.String getMaxGuestApplicable()

Get the 'MaxGuestApplicable' attribute value. Indicates the maximum number of guests at this rate.

Returns:

value

setMaxGuestApplicable

public void setMaxGuestApplicable(java.lang.String maxGuestApplicable)

Set the 'MaxGuestApplicable' attribute value. Indicates the maximum number of guests at this rate.

Parameters:

maxGuestApplicable -

getMinLOS

public java.lang.Integer getMinLOS()

Get the 'MinLOS' attribute value. Indicates the minimum length of stay.

Returns:

value

setMinLOS

public void setMinLOS(java.lang.Integer minLOS)

Set the 'MinLOS' attribute value. Indicates the minimum length of stay.

Parameters:

minLOS -

getMaxLOS

public java.lang.Integer getMaxLOS()

Get the 'MaxLOS' attribute value. Indicates the maximum length of stay.

Returns:

value

setMaxLOS

public void setMaxLOS(java.lang.Integer maxLOS)

Set the 'MaxLOS' attribute value. Indicates the maximum length of stay.

Parameters:

maxLOS -

getStayOverDate

public DayOfWeek getStayOverDate()

Get the 'StayOverDate' attribute value. Day of week guest is required to stay over in order to be eligible for this rate.

Returns:

value

setStayOverDate

public void setStayOverDate(DayOfWeek stayOverDate)

Set the 'StayOverDate' attribute value. Day of week guest is required to stay over in order to be eligible for this rate.

Parameters:

stayOverDate -

getAlternateCurrencyInd

public java.lang.Boolean getAlternateCurrencyInd()

Get the 'AlternateCurrencyInd' attribute value. When true, indicates the amounts are provided in an alternate currency. When false, indicates the amounts are provided in the primary currency. This may be used to indicate that the currency provided is different from the requested or stored currency .

Returns:

value

setAlternateCurrencyInd

public void setAlternateCurrencyInd(java.lang.Boolean alternateCurrencyInd)

Set the 'AlternateCurrencyInd' attribute value. When true, indicates the amounts are provided in an alternate currency. When false, indicates the amounts are provided in the primary currency. This may be used to indicate that the currency provided is different from the requested or stored currency .

Parameters:

alternateCurrencyInd -