org.ota.hotel
Class RateUpload

java.lang.Object
  org.ota.hotel.RateUpload

Direct Known Subclasses:

HotelRatePlan.Rates.Rate, InvBlock.RoomTypes.Room.RatePlans.RatePlan, RateAmountMessage.Rates.Rate

public class RateUpload
extends java.lang.Object

Defines the details of a rate. 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="RateUploadType">
   <xs:sequence>
     <xs:element name="BaseByGuestAmts" minOccurs="0">
       <!-- Reference to inner class BaseByGuestAmts -->
     </xs:element>
     <xs:element name="AdditionalGuestAmounts" minOccurs="0">
       <!-- Reference to inner class AdditionalGuestAmounts -->
     </xs:element>
     <xs:element type="ns:FeesType" name="Fees" minOccurs="0"/>
     <xs:element name="GuaranteePolicies" minOccurs="0">
       <!-- Reference to inner class GuaranteePolicies -->
     </xs:element>
     <xs:element type="ns:CancelPenaltiesType" name="CancelPolicies" minOccurs="0"/>
     <xs:element type="ns:RequiredPaymentsType" name="PaymentPolicies" minOccurs="0"/>
     <xs:element type="ns:ParagraphType" name="RateDescription" minOccurs="0"/>
     <xs:element type="ns:UniqueID_Type" name="UniqueID" minOccurs="0"/>
     <xs:element name="MealsIncluded" minOccurs="0">
       <xs:complexType>
         <xs:attributeGroup ref="ns:MealsIncludedGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element type="ns:HotelAdditionalChargesType" name="AdditionalCharges" minOccurs="0"/>
   </xs:sequence>
   <xs:attribute type="xs:int" use="optional" name="NumberOfUnits"/>
   <xs:attribute type="ns:TimeUnitType" use="optional" name="RateTimeUnit"/>
   <xs:attribute type="xs:int" use="optional" name="UnitMultiplier"/>
   <xs:attribute type="xs:int" use="optional" name="MinGuestApplicable"/>
   <xs:attribute type="xs:int" use="optional" name="MaxGuestApplicable"/>
   <xs:attributeGroup ref="ns:AgeQualifyingGroup"/>
   <xs:attribute type="xs:string" use="optional" name="MinLOS"/>
   <xs:attribute type="xs:string" use="optional" name="MaxLOS"/>
   <xs:attribute type="ns:DayOfWeekType" use="optional" name="StayOverDate"/>
   <xs:attributeGroup ref="ns:DateTimeSpanGroup"/>
   <xs:attributeGroup ref="ns:DOW_PatternGroup"/>
   <xs:attributeGroup ref="ns:CurrencyCodeGroup"/>
   <xs:attribute type="xs:string" use="optional" name="RateTier"/>
 </xs:complexType>
 

Nested Class Summary

static class	RateUpload.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	RateUpload.BaseByGuestAmts A collection of Base charges by number of guests.
static class	RateUpload.GuaranteePolicies A collection of Guarantee Policies Schema fragment(s) for this class:

Constructor Summary

RateUpload()

Method Summary

HotelAdditionalCharges	getAdditionalCharges() Get the 'AdditionalCharges' element value.
RateUpload.AdditionalGuestAmounts	getAdditionalGuestAmounts() Get the 'AdditionalGuestAmounts' element value.
AgeQualifyingGroup	getAgeQualifyingGroup() Get the 'AgeQualifyingGroup' attributeGroup value.
RateUpload.BaseByGuestAmts	getBaseByGuestAmts() Get the 'BaseByGuestAmts' element value.
CancelPenalties	getCancelPolicies() Get the 'CancelPolicies' element value.
CurrencyCodeGroup	getCurrencyCodeGroup() Get the 'CurrencyCodeGroup' attributeGroup value.
DateTimeSpanGroup	getDateTimeSpanGroup() Get the 'DateTimeSpanGroup' attributeGroup value.
DOWPatternGroup	getDOWPatternGroup() Get the 'DOW_PatternGroup' attributeGroup value.
Fees	getFees() Get the 'Fees' element value.
RateUpload.GuaranteePolicies	getGuaranteePolicies() Get the 'GuaranteePolicies' element value.
java.lang.Integer	getMaxGuestApplicable() Get the 'MaxGuestApplicable' attribute value.
java.lang.String	getMaxLOS() Get the 'MaxLOS' attribute value.
MealsIncludedGroup	getMealsIncluded() Get the 'MealsIncludedGroup' attributeGroup value.
java.lang.Integer	getMinGuestApplicable() Get the 'MinGuestApplicable' attribute value.
java.lang.String	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.
java.lang.String	getRateTier() Get the 'RateTier' attribute value.
TimeUnit	getRateTimeUnit() Get the 'RateTimeUnit' attribute value.
DayOfWeek	getStayOverDate() Get the 'StayOverDate' attribute value.
UniqueID	getUniqueID() Get the 'UniqueID' element value.
java.lang.Integer	getUnitMultiplier() Get the 'UnitMultiplier' attribute value.
void	setAdditionalCharges(HotelAdditionalCharges additionalCharges) Set the 'AdditionalCharges' element value.
void	setAdditionalGuestAmounts(RateUpload.AdditionalGuestAmounts additionalGuestAmounts) Set the 'AdditionalGuestAmounts' element value.
void	setAgeQualifyingGroup(AgeQualifyingGroup ageQualifyingGroup) Set the 'AgeQualifyingGroup' attributeGroup value.
void	setBaseByGuestAmts(RateUpload.BaseByGuestAmts baseByGuestAmts) Set the 'BaseByGuestAmts' element value.
void	setCancelPolicies(CancelPenalties cancelPolicies) Set the 'CancelPolicies' element value.
void	setCurrencyCodeGroup(CurrencyCodeGroup currencyCodeGroup) Set the 'CurrencyCodeGroup' attributeGroup value.
void	setDateTimeSpanGroup(DateTimeSpanGroup dateTimeSpanGroup) Set the 'DateTimeSpanGroup' attributeGroup value.
void	setDOWPatternGroup(DOWPatternGroup DOWPatternGroup) Set the 'DOW_PatternGroup' attributeGroup value.
void	setFees(Fees fees) Set the 'Fees' element value.
void	setGuaranteePolicies(RateUpload.GuaranteePolicies guaranteePolicies) Set the 'GuaranteePolicies' element value.
void	setMaxGuestApplicable(java.lang.Integer maxGuestApplicable) Set the 'MaxGuestApplicable' attribute value.
void	setMaxLOS(java.lang.String maxLOS) Set the 'MaxLOS' attribute value.
void	setMealsIncluded(MealsIncludedGroup mealsIncluded) Set the 'MealsIncludedGroup' attributeGroup value.
void	setMinGuestApplicable(java.lang.Integer minGuestApplicable) Set the 'MinGuestApplicable' attribute value.
void	setMinLOS(java.lang.String 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	setRateTier(java.lang.String rateTier) Set the 'RateTier' attribute value.
void	setRateTimeUnit(TimeUnit rateTimeUnit) Set the 'RateTimeUnit' attribute value.
void	setStayOverDate(DayOfWeek stayOverDate) Set the 'StayOverDate' attribute value.
void	setUniqueID(UniqueID uniqueID) Set the 'UniqueID' element value.
void	setUnitMultiplier(java.lang.Integer unitMultiplier) Set the 'UnitMultiplier' attribute value.

Methods inherited from class java.lang.Object

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

Constructor Detail

RateUpload

public RateUpload()

Method Detail

getBaseByGuestAmts

public RateUpload.BaseByGuestAmts getBaseByGuestAmts()

Get the 'BaseByGuestAmts' element value.

Returns:

value

setBaseByGuestAmts

public void setBaseByGuestAmts(RateUpload.BaseByGuestAmts baseByGuestAmts)

Set the 'BaseByGuestAmts' element value.

Parameters:

baseByGuestAmts -

getAdditionalGuestAmounts

public RateUpload.AdditionalGuestAmounts getAdditionalGuestAmounts()

Get the 'AdditionalGuestAmounts' element value.

Returns:

value

setAdditionalGuestAmounts

public void setAdditionalGuestAmounts(RateUpload.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 -

getGuaranteePolicies

public RateUpload.GuaranteePolicies getGuaranteePolicies()

Get the 'GuaranteePolicies' element value.

Returns:

value

setGuaranteePolicies

public void setGuaranteePolicies(RateUpload.GuaranteePolicies guaranteePolicies)

Set the 'GuaranteePolicies' element value.

Parameters:

guaranteePolicies -

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 -

getRateDescription

public Paragraph getRateDescription()

Get the 'RateDescription' element value. Desription of Rate being uploaded.

Returns:

value

setRateDescription

public void setRateDescription(Paragraph rateDescription)

Set the 'RateDescription' element value. Desription of Rate being uploaded.

Parameters:

rateDescription -

getUniqueID

public UniqueID getUniqueID()

Get the 'UniqueID' element value. The unique identifier element allows the trading partners to uniquely identify each Rate being uploaded, for traceable transactions.

Returns:

value

setUniqueID

public void setUniqueID(UniqueID uniqueID)

Set the 'UniqueID' element value. The unique identifier element allows the trading partners to uniquely identify each Rate being uploaded, for traceable transactions.

Parameters:

uniqueID -

getMealsIncluded

public MealsIncludedGroup getMealsIncluded()

Get the 'MealsIncludedGroup' attributeGroup value. Defines which meals are included with this rate program.

Returns:

value

setMealsIncluded

public void setMealsIncluded(MealsIncludedGroup mealsIncluded)

Set the 'MealsIncludedGroup' attributeGroup value. Defines which meals are included with this rate program.

Parameters:

mealsIncluded -

getAdditionalCharges

public HotelAdditionalCharges getAdditionalCharges()

Get the 'AdditionalCharges' element value. Breakout of additional charges as part of the rate plan.

Returns:

value

setAdditionalCharges

public void setAdditionalCharges(HotelAdditionalCharges additionalCharges)

Set the 'AdditionalCharges' element value. Breakout of additional charges as part of the rate plan.

Parameters:

additionalCharges -

getNumberOfUnits

public java.lang.Integer getNumberOfUnits()

Get the 'NumberOfUnits' attribute value. Indicates the number of rooms blocked or capped for this rate plan.

Returns:

value

setNumberOfUnits

public void setNumberOfUnits(java.lang.Integer numberOfUnits)

Set the 'NumberOfUnits' attribute value. Indicates the number of rooms blocked or capped for this rate plan.

Parameters:

numberOfUnits -

getRateTimeUnit

public TimeUnit getRateTimeUnit()

Get the 'RateTimeUnit' attribute value. Enumeration of time units upon which the RateAmount is based (e.g., daily, weekly, single rate for full stay).

Returns:

value

setRateTimeUnit

public void setRateTimeUnit(TimeUnit rateTimeUnit)

Set the 'RateTimeUnit' attribute value. Enumeration of time units upon which the RateAmount is based (e.g., daily, weekly, single rate for full stay).

Parameters:

rateTimeUnit -

getUnitMultiplier

public java.lang.Integer getUnitMultiplier()

Get the 'UnitMultiplier' attribute value. The number of RateTimeUnits that the rate Amount is based upon (e.g., flat rate for 3 days).

Returns:

value

setUnitMultiplier

public void setUnitMultiplier(java.lang.Integer unitMultiplier)

Set the 'UnitMultiplier' attribute value. The number of RateTimeUnits that the rate Amount is based upon (e.g., flat rate for 3 days).

Parameters:

unitMultiplier -

getMinGuestApplicable

public java.lang.Integer getMinGuestApplicable()

Get the 'MinGuestApplicable' attribute value. Minimum number of occupants for which this rate is valid (ex 1).

Returns:

value

setMinGuestApplicable

public void setMinGuestApplicable(java.lang.Integer minGuestApplicable)

Set the 'MinGuestApplicable' attribute value. Minimum number of occupants for which this rate is valid (ex 1).

Parameters:

minGuestApplicable -

getMaxGuestApplicable

public java.lang.Integer getMaxGuestApplicable()

Get the 'MaxGuestApplicable' attribute value. Maximum number of occupants for which this rate is valid (ex 2).

Returns:

value

setMaxGuestApplicable

public void setMaxGuestApplicable(java.lang.Integer maxGuestApplicable)

Set the 'MaxGuestApplicable' attribute value. Maximum number of occupants for which this rate is valid (ex 2).

Parameters:

maxGuestApplicable -

getAgeQualifyingGroup

public AgeQualifyingGroup getAgeQualifyingGroup()

Get the 'AgeQualifyingGroup' attributeGroup value.

Returns:

value

setAgeQualifyingGroup

public void setAgeQualifyingGroup(AgeQualifyingGroup ageQualifyingGroup)

Set the 'AgeQualifyingGroup' attributeGroup value.

Parameters:

ageQualifyingGroup -

getMinLOS

public java.lang.String getMinLOS()

Get the 'MinLOS' attribute value. The minimum length of stay required by this rate plan.

Returns:

value

setMinLOS

public void setMinLOS(java.lang.String minLOS)

Set the 'MinLOS' attribute value. The minimum length of stay required by this rate plan.

Parameters:

minLOS -

getMaxLOS

public java.lang.String getMaxLOS()

Get the 'MaxLOS' attribute value. The maximum length of stay allowed by this rate plan.

Returns:

value

setMaxLOS

public void setMaxLOS(java.lang.String maxLOS)

Set the 'MaxLOS' attribute value. The maximum length of stay allowed by this rate plan.

Parameters:

maxLOS -

getStayOverDate

public DayOfWeek getStayOverDate()

Get the 'StayOverDate' attribute value. Indicates a specific day on which the guest must stay over in order to be eligible for the quoted rate plan.

Returns:

value

setStayOverDate

public void setStayOverDate(DayOfWeek stayOverDate)

Set the 'StayOverDate' attribute value. Indicates a specific day on which the guest must stay over in order to be eligible for the quoted rate plan.

Parameters:

stayOverDate -

getDateTimeSpanGroup

public DateTimeSpanGroup getDateTimeSpanGroup()

Get the 'DateTimeSpanGroup' attributeGroup value.

Returns:

value

setDateTimeSpanGroup

public void setDateTimeSpanGroup(DateTimeSpanGroup dateTimeSpanGroup)

Set the 'DateTimeSpanGroup' attributeGroup value.

Parameters:

dateTimeSpanGroup -

getDOWPatternGroup

public DOWPatternGroup getDOWPatternGroup()

Get the 'DOW_PatternGroup' attributeGroup value.

Returns:

value

setDOWPatternGroup

public void setDOWPatternGroup(DOWPatternGroup DOWPatternGroup)

Set the 'DOW_PatternGroup' attributeGroup value.

Parameters:

DOWPatternGroup -

getCurrencyCodeGroup

public CurrencyCodeGroup getCurrencyCodeGroup()

Get the 'CurrencyCodeGroup' attributeGroup value.

Returns:

value

setCurrencyCodeGroup

public void setCurrencyCodeGroup(CurrencyCodeGroup currencyCodeGroup)

Set the 'CurrencyCodeGroup' attributeGroup value.

Parameters:

currencyCodeGroup -

getRateTier

public java.lang.String getRateTier()

Get the 'RateTier' attribute value. Hotel systems often have different tiers for a given rate plan; this attribute is used to designate a specific tier within the rate plan (e.g. high, medium, low).

Returns:

value

setRateTier

public void setRateTier(java.lang.String rateTier)

Set the 'RateTier' attribute value. Hotel systems often have different tiers for a given rate plan; this attribute is used to designate a specific tier within the rate plan (e.g. high, medium, low).

Parameters:

rateTier -