org.ota.hotel
Class RatePlan

java.lang.Object
  org.ota.hotel.RatePlan

public class RatePlan
extends java.lang.Object

Defines the details of the rate plan as used in the booking process.Policies and descriptions that apply to a rate plan.Information significant to defining a rate plan. 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="RatePlanType">
   <xs:sequence minOccurs="0">
     <!-- Reference to inner class Sequence -->
   </xs:sequence>
   <xs:attribute type="xs:string" use="optional" name="BookingCode"/>
   <xs:attribute type="xs:string" use="optional" name="RatePlanCode"/>
   <xs:attributeGroup ref="ns:EffectiveExpireOptionalDateGroup"/>
   <xs:attribute type="ns:RateIndicatorType" use="optional" name="RateIndicator"/>
   <xs:attribute type="xs:string" use="optional" name="RatePlanType"/>
   <xs:attribute type="xs:string" use="optional" name="RatePlanID"/>
   <xs:attribute type="xs:string" use="optional" name="RatePlanName"/>
   <xs:attribute type="xs:string" use="optional" name="MarketCode"/>
   <xs:attribute type="ns:RateIndicatorType" use="optional" name="AvailabilityStatus"/>
   <xs:attribute type="xs:boolean" use="optional" name="ID_RequiredInd"/>
   <xs:attribute type="xs:boolean" use="optional" name="PriceViewableInd"/>
   <xs:attribute type="xs:string" use="optional" name="QualificationType"/>
   <xs:attribute type="xs:int" use="optional" name="AvailableQuantity"/>
   <xs:attribute type="xs:boolean" use="optional" name="PrepaidIndicator"/>
 </xs:complexType>
 

Nested Class Summary

static class

RatePlan.Sequence Schema fragment(s) for this class:

Constructor Summary

RatePlan()

Method Summary

RateIndicator	getAvailabilityStatus() Get the 'AvailabilityStatus' attribute value.
java.lang.Integer	getAvailableQuantity() Get the 'AvailableQuantity' attribute value.
java.lang.String	getBookingCode() Get the 'BookingCode' attribute value.
EffectiveExpireOptionalDateGroup	getEffectiveExpireOptionalDateGroup() Get the 'EffectiveExpireOptionalDateGroup' attributeGroup value.
java.lang.Boolean	getIDRequiredInd() Get the 'ID_RequiredInd' attribute value.
java.lang.String	getMarketCode() Get the 'MarketCode' attribute value.
java.lang.Boolean	getPrepaidIndicator() Get the 'PrepaidIndicator' attribute value.
java.lang.Boolean	getPriceViewableInd() Get the 'PriceViewableInd' attribute value.
java.lang.String	getQualification() Get the 'QualificationType' attribute value.
RateIndicator	getRateIndicator() Get the 'RateIndicator' attribute value.
java.lang.String	getRatePlan() Get the 'RatePlanType' attribute value.
java.lang.String	getRatePlanCode() Get the 'RatePlanCode' attribute value.
java.lang.String	getRatePlanID() Get the 'RatePlanID' attribute value.
java.lang.String	getRatePlanName() Get the 'RatePlanName' attribute value.
RatePlan.Sequence	getSequence() Get the sequence value.
void	setAvailabilityStatus(RateIndicator availabilityStatus) Set the 'AvailabilityStatus' attribute value.
void	setAvailableQuantity(java.lang.Integer availableQuantity) Set the 'AvailableQuantity' attribute value.
void	setBookingCode(java.lang.String bookingCode) Set the 'BookingCode' attribute value.
void	setEffectiveExpireOptionalDateGroup(EffectiveExpireOptionalDateGroup effectiveExpireOptionalDateGroup) Set the 'EffectiveExpireOptionalDateGroup' attributeGroup value.
void	setIDRequiredInd(java.lang.Boolean IDRequiredInd) Set the 'ID_RequiredInd' attribute value.
void	setMarketCode(java.lang.String marketCode) Set the 'MarketCode' attribute value.
void	setPrepaidIndicator(java.lang.Boolean prepaidIndicator) Set the 'PrepaidIndicator' attribute value.
void	setPriceViewableInd(java.lang.Boolean priceViewableInd) Set the 'PriceViewableInd' attribute value.
void	setQualification(java.lang.String qualification) Set the 'QualificationType' attribute value.
void	setRateIndicator(RateIndicator rateIndicator) Set the 'RateIndicator' attribute value.
void	setRatePlan(java.lang.String ratePlan) Set the 'RatePlanType' attribute value.
void	setRatePlanCode(java.lang.String ratePlanCode) Set the 'RatePlanCode' attribute value.
void	setRatePlanID(java.lang.String ratePlanID) Set the 'RatePlanID' attribute value.
void	setRatePlanName(java.lang.String ratePlanName) Set the 'RatePlanName' attribute value.
void	setSequence(RatePlan.Sequence sequence) Set the sequence value.

Methods inherited from class java.lang.Object

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

Constructor Detail

RatePlan

public RatePlan()

Method Detail

getSequence

public RatePlan.Sequence getSequence()

Get the sequence value.

Returns:

value

setSequence

public void setSequence(RatePlan.Sequence sequence)

Set the sequence value.

Parameters:

sequence -

getBookingCode

public java.lang.String getBookingCode()

Get the 'BookingCode' attribute value. This is used to indicate the item booked and is primarily used to exchange information with GDSs.

Returns:

value

setBookingCode

public void setBookingCode(java.lang.String bookingCode)

Set the 'BookingCode' attribute value. This is used to indicate the item booked and is primarily used to exchange information with GDSs.

Parameters:

bookingCode -

getRatePlanCode

public java.lang.String getRatePlanCode()

Get the 'RatePlanCode' attribute value. The RatePlanCode assigned by the receiving system for the inventory item in response to a new rate plan notification. (Implementation Notes: This would only be returned when the notification is of type New and the sender is translating RatePlanCode values. On subsequent transactions for this rate plan, the sender would populate the RatePlanCode attribute with this value returned by the receiver.)

Returns:

value

setRatePlanCode

public void setRatePlanCode(java.lang.String ratePlanCode)

Set the 'RatePlanCode' attribute value. The RatePlanCode assigned by the receiving system for the inventory item in response to a new rate plan notification. (Implementation Notes: This would only be returned when the notification is of type New and the sender is translating RatePlanCode values. On subsequent transactions for this rate plan, the sender would populate the RatePlanCode attribute with this value returned by the receiver.)

Parameters:

ratePlanCode -

getEffectiveExpireOptionalDateGroup

public EffectiveExpireOptionalDateGroup getEffectiveExpireOptionalDateGroup()

Get the 'EffectiveExpireOptionalDateGroup' attributeGroup value.

Returns:

value

setEffectiveExpireOptionalDateGroup

public void setEffectiveExpireOptionalDateGroup(EffectiveExpireOptionalDateGroup effectiveExpireOptionalDateGroup)

Set the 'EffectiveExpireOptionalDateGroup' attributeGroup value.

Parameters:

effectiveExpireOptionalDateGroup -

getRateIndicator

public RateIndicator getRateIndicator()

Get the 'RateIndicator' attribute value. Information pertaining to the availability of the rate plan.

Returns:

value

setRateIndicator

public void setRateIndicator(RateIndicator rateIndicator)

Set the 'RateIndicator' attribute value. Information pertaining to the availability of the rate plan.

Parameters:

rateIndicator -

getRatePlan

public java.lang.String getRatePlan()

Get the 'RatePlanType' attribute value. An enumerated type that allows the query to specify a rate category type, and provides major categories for comparison across brands. Refer to OpenTravel Code List Rate Plan Type (RPT).

Returns:

value

setRatePlan

public void setRatePlan(java.lang.String ratePlan)

Set the 'RatePlanType' attribute value. An enumerated type that allows the query to specify a rate category type, and provides major categories for comparison across brands. Refer to OpenTravel Code List Rate Plan Type (RPT).

Parameters:

ratePlan -

getRatePlanID

public java.lang.String getRatePlanID()

Get the 'RatePlanID' attribute value. A text field used to provide a special ID code that is associated with the rate and is required in the reservation request in order to obtain the rate. Examples are a corporate ID number, a promotion code or a membership number.

Returns:

value

setRatePlanID

public void setRatePlanID(java.lang.String ratePlanID)

Set the 'RatePlanID' attribute value. A text field used to provide a special ID code that is associated with the rate and is required in the reservation request in order to obtain the rate. Examples are a corporate ID number, a promotion code or a membership number.

Parameters:

ratePlanID -

getRatePlanName

public java.lang.String getRatePlanName()

Get the 'RatePlanName' attribute value. Provides the name of the rate plan or group. Typically used with RatePlanType to further describe the rate plan.

Returns:

value

setRatePlanName

public void setRatePlanName(java.lang.String ratePlanName)

Set the 'RatePlanName' attribute value. Provides the name of the rate plan or group. Typically used with RatePlanType to further describe the rate plan.

Parameters:

ratePlanName -

getMarketCode

public java.lang.String getMarketCode()

Get the 'MarketCode' attribute value. The code that relates to the market being sold to (e.g., the corporate market, packages).

Returns:

value

setMarketCode

public void setMarketCode(java.lang.String marketCode)

Set the 'MarketCode' attribute value. The code that relates to the market being sold to (e.g., the corporate market, packages).

Parameters:

marketCode -

getAvailabilityStatus

public RateIndicator getAvailabilityStatus()

Get the 'AvailabilityStatus' attribute value. Used to specify an availability status for the rate plan.

Returns:

value

setAvailabilityStatus

public void setAvailabilityStatus(RateIndicator availabilityStatus)

Set the 'AvailabilityStatus' attribute value. Used to specify an availability status for the rate plan.

Parameters:

availabilityStatus -

getIDRequiredInd

public java.lang.Boolean getIDRequiredInd()

Get the 'ID_RequiredInd' attribute value. When true, indicates proof of qualification for this rate is required.

Returns:

value

setIDRequiredInd

public void setIDRequiredInd(java.lang.Boolean IDRequiredInd)

Set the 'ID_RequiredInd' attribute value. When true, indicates proof of qualification for this rate is required.

Parameters:

IDRequiredInd -

getPriceViewableInd

public java.lang.Boolean getPriceViewableInd()

Get the 'PriceViewableInd' attribute value. When true, the price for this rate plan can be viewed by the guest. When false, the guest must contact another entity to obtain price information.

Returns:

value

setPriceViewableInd

public void setPriceViewableInd(java.lang.Boolean priceViewableInd)

Set the 'PriceViewableInd' attribute value. When true, the price for this rate plan can be viewed by the guest. When false, the guest must contact another entity to obtain price information.

Parameters:

priceViewableInd -

getQualification

public java.lang.String getQualification()

Get the 'QualificationType' attribute value. Indicates the type of document required by the guest to qualify for this rate plan. Refer to OpenTravel Code List Document Type (DOC).

Returns:

value

setQualification

public void setQualification(java.lang.String qualification)

Set the 'QualificationType' attribute value. Indicates the type of document required by the guest to qualify for this rate plan. Refer to OpenTravel Code List Document Type (DOC).

Parameters:

qualification -

getAvailableQuantity

public java.lang.Integer getAvailableQuantity()

Get the 'AvailableQuantity' attribute value. Provides the number of rooms available within this rate plan.

Returns:

value

setAvailableQuantity

public void setAvailableQuantity(java.lang.Integer availableQuantity)

Set the 'AvailableQuantity' attribute value. Provides the number of rooms available within this rate plan.

Parameters:

availableQuantity -

getPrepaidIndicator

public java.lang.Boolean getPrepaidIndicator()

Get the 'PrepaidIndicator' attribute value. When true, indicates if the rate is a prepaid rate.

Returns:

value

setPrepaidIndicator

public void setPrepaidIndicator(java.lang.Boolean prepaidIndicator)

Set the 'PrepaidIndicator' attribute value. When true, indicates if the rate is a prepaid rate.

Parameters:

prepaidIndicator -