org.ota.hotel
Class Rate.RateInner

java.lang.Object
  extended by org.ota.hotel.Amount
      extended by org.ota.hotel.Rate.RateInner
Enclosing class:
Rate

public static class Rate.RateInner
extends Amount

The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts as well as payment and cancellation policies. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount The applicable period of the the rate are indicated by the effective dates. Restrictions that may apply to that rate, such as the minimum or maximum length of stay, stay-over dates (such as a Saturday night), min/max guests applicable for the rate, and age group (ex Adult) are attributes of Rate. It indicates the number of units that the quoted rate is based upon, as well as the TimeUnits type used that the rate is based upon, e.g.: 3days at $100.00 per day. Schema fragment(s) for this class:

 <xs:element xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="Rate" maxOccurs="unbounded">
   <xs:complexType>
     <xs:complexContent>
       <xs:extension base="ns:AmountType">
         <xs:sequence>
           <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
         </xs:sequence>
         <xs:attribute type="xs:string" use="optional" name="Duration"/>
         <xs:attribute type="xs:string" use="optional" name="RateMode"/>
         <xs:attribute type="xs:boolean" use="optional" name="CachedIndicator"/>
         <xs:attribute type="xs:string" use="optional" name="RateSource"/>
         <xs:attribute type="xs:string" use="optional" name="RateTypeCode"/>
         <xs:attribute type="ns:PricingType" use="optional" name="RoomPricingType"/>
       </xs:extension>
     </xs:complexContent>
   </xs:complexType>
 </xs:element>
 
 <xs:element xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" type="ns:TPA_ExtensionsType" name="TPA_Extensions"/>
 


Nested Class Summary
 
Nested classes/interfaces inherited from class org.ota.hotel.Amount
Amount.AdditionalGuestAmounts, Amount.Discount
 
Constructor Summary
Rate.RateInner()
           
 
Method Summary
 java.lang.Boolean getCachedIndicator()
          Get the 'CachedIndicator' attribute value.
 java.lang.String getDuration()
          Get the 'Duration' attribute value.
 java.lang.String getRateMode()
          Get the 'RateMode' attribute value.
 java.lang.String getRateSource()
          Get the 'RateSource' attribute value.
 java.lang.String getRateTypeCode()
          Get the 'RateTypeCode' attribute value.
 Pricing getRoomPricing()
          Get the 'RoomPricingType' attribute value.
 TPAExtensions getTPAExtensions()
          Get the 'TPA_Extensions' element value.
 void setCachedIndicator(java.lang.Boolean cachedIndicator)
          Set the 'CachedIndicator' attribute value.
 void setDuration(java.lang.String duration)
          Set the 'Duration' attribute value.
 void setRateMode(java.lang.String rateMode)
          Set the 'RateMode' attribute value.
 void setRateSource(java.lang.String rateSource)
          Set the 'RateSource' attribute value.
 void setRateTypeCode(java.lang.String rateTypeCode)
          Set the 'RateTypeCode' attribute value.
 void setRoomPricing(Pricing roomPricing)
          Set the 'RoomPricingType' attribute value.
 void setTPAExtensions(TPAExtensions TPAExtensions)
          Set the 'TPA_Extensions' element value.
 
Methods inherited from class org.ota.hotel.Amount
addDiscount, clearDiscounts, getAdditionalCharges, getAdditionalGuestAmounts, getAgeQualifyingGroup, getAlternateCurrencyInd, getBase, getCancelPolicies, getDiscount, getDiscounts, getEffectiveExpireOptionalDateGroup, getFees, getGuaranteedInd, getMaxGuestApplicable, getMaxLOS, getMinGuestApplicable, getMinLOS, getNumberOfUnits, getPaymentPolicies, getRateDescription, getRateTimeUnit, getStayOverDate, getTotal, getUnitMultiplier, setAdditionalCharges, setAdditionalGuestAmounts, setAgeQualifyingGroup, setAlternateCurrencyInd, setBase, setCancelPolicies, setDiscounts, setEffectiveExpireOptionalDateGroup, setFees, setGuaranteedInd, setMaxGuestApplicable, setMaxLOS, setMinGuestApplicable, setMinLOS, setNumberOfUnits, setPaymentPolicies, setRateDescription, setRateTimeUnit, setStayOverDate, setTotal, setUnitMultiplier, sizeDiscounts
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Rate.RateInner

public Rate.RateInner()
Method Detail

getTPAExtensions

public TPAExtensions getTPAExtensions()
Get the 'TPA_Extensions' element value. A placeholder in the schema to allow for additional elements and attributes to be included if required, per Trading Partner Agreement (TPA).

Returns:
value

setTPAExtensions

public void setTPAExtensions(TPAExtensions TPAExtensions)
Set the 'TPA_Extensions' element value. A placeholder in the schema to allow for additional elements and attributes to be included if required, per Trading Partner Agreement (TPA).

Parameters:
TPAExtensions -

getDuration

public java.lang.String getDuration()
Get the 'Duration' attribute value.

Returns:
value

setDuration

public void setDuration(java.lang.String duration)
Set the 'Duration' attribute value.

Parameters:
duration -

getRateMode

public java.lang.String getRateMode()
Get the 'RateMode' attribute value. This supports returning a type of rate (minimum, maximum, etc.) as an alternative to returning a specific rate. Refer to OpenTravel Code List Rate Mode (RMO).

Returns:
value

setRateMode

public void setRateMode(java.lang.String rateMode)
Set the 'RateMode' attribute value. This supports returning a type of rate (minimum, maximum, etc.) as an alternative to returning a specific rate. Refer to OpenTravel Code List Rate Mode (RMO).

Parameters:
rateMode -

getCachedIndicator

public java.lang.Boolean getCachedIndicator()
Get the 'CachedIndicator' attribute value. When true, this indicates the rate data is not real-time.

Returns:
value

setCachedIndicator

public void setCachedIndicator(java.lang.Boolean cachedIndicator)
Set the 'CachedIndicator' attribute value. When true, this indicates the rate data is not real-time.

Parameters:
cachedIndicator -

getRateSource

public java.lang.String getRateSource()
Get the 'RateSource' attribute value. The source from which the rate was acquired.

Returns:
value

setRateSource

public void setRateSource(java.lang.String rateSource)
Set the 'RateSource' attribute value. The source from which the rate was acquired.

Parameters:
rateSource -

getRateTypeCode

public java.lang.String getRateTypeCode()
Get the 'RateTypeCode' attribute value. Used to identify the type of rate. Refer to OpenTravel Code list Rate Plan Type (RPT).

Returns:
value

setRateTypeCode

public void setRateTypeCode(java.lang.String rateTypeCode)
Set the 'RateTypeCode' attribute value. Used to identify the type of rate. Refer to OpenTravel Code list Rate Plan Type (RPT).

Parameters:
rateTypeCode -

getRoomPricing

public Pricing getRoomPricing()
Get the 'RoomPricingType' attribute value. Specifies how the room is priced (per night, per person, etc.).

Returns:
value

setRoomPricing

public void setRoomPricing(Pricing roomPricing)
Set the 'RoomPricingType' attribute value. Specifies how the room is priced (per night, per person, etc.).

Parameters:
roomPricing -