org.ota.hotel
Class BookingRules.BookingRule

java.lang.Object
  org.ota.hotel.BookingRules.BookingRule

Enclosing class:

BookingRules

public static class BookingRules.BookingRule
extends java.lang.Object

The BookingRule element defines restrictions to rates and stays at the hotel for a given rate plan, room type or rate plan/room type combination. 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="BookingRule" maxOccurs="unbounded">
   <xs:complexType>
     <xs:sequence>
       <xs:element name="AcceptableGuarantees" minOccurs="0">
         <!-- Reference to inner class AcceptableGuarantees -->
       </xs:element>
       <xs:element type="ns:CancelPenaltiesType" name="CancelPenalties" minOccurs="0"/>
       <xs:element type="ns:RequiredPaymentsType" name="RequiredPaymts" minOccurs="0"/>
       <xs:element type="ns:LengthsOfStayType" name="LengthsOfStay" minOccurs="0"/>
       <xs:element type="ns:DOW_RestrictionsType" name="DOW_Restrictions" minOccurs="0"/>
       <xs:element name="RestrictionStatus" minOccurs="0">
         <xs:complexType>
           <xs:attributeGroup ref="ns:RestrictionStatusGroup"/>
         </xs:complexType>
       </xs:element>
       <xs:element type="ns:ViewershipsType" name="Viewerships" minOccurs="0"/>
       <xs:element name="AddtionalRules" minOccurs="0">
         <!-- Reference to inner class AddtionalRules -->
       </xs:element>
       <xs:element type="ns:ParagraphType" name="Description" minOccurs="0" maxOccurs="20"/>
       <xs:element type="ns:UniqueID_Type" name="UniqueID" minOccurs="0"/>
       <xs:element name="CheckoutCharge" minOccurs="0" maxOccurs="2">
         <!-- Reference to inner class CheckoutCharge -->
       </xs:element>
     </xs:sequence>
     <xs:attributeGroup ref="ns:CodeListGroup"/>
     <xs:attributeGroup ref="ns:DateTimeSpanGroup"/>
     <xs:attribute type="xs:string" use="optional" name="MaxAdvancedBookingOffset"/>
     <xs:attribute type="xs:string" use="optional" name="MinAdvancedBookingOffset"/>
     <xs:attribute type="xs:string" use="optional" name="ForceGuaranteeOffset"/>
     <xs:attribute type="xs:string" use="optional" name="DepositWaiverOffset"/>
     <xs:attribute type="xs:int" use="optional" name="MinTotalOccupancy"/>
     <xs:attribute type="xs:int" use="optional" name="MaxTotalOccupancy"/>
     <xs:attribute type="xs:string" use="optional" name="AbsoluteDropTime"/>
     <xs:attribute type="xs:boolean" use="optional" name="GenerallyBookable"/>
     <xs:attribute type="xs:boolean" use="optional" name="PriceViewable"/>
     <xs:attribute type="xs:boolean" use="optional" name="QualifiedRateYN"/>
     <xs:attribute type="xs:boolean" use="optional" name="AddressRequired"/>
     <xs:attributeGroup ref="ns:InvBlockCutoffGroup"/>
     <xs:attribute type="xs:int" use="optional" name="MaxContiguousBookings"/>
   </xs:complexType>
 </xs:element>
 

Nested Class Summary

static class	BookingRules.BookingRule.AcceptableGuarantees A collection of accepted guarantees.
static class	BookingRules.BookingRule.AddtionalRules A collection of Additional rules Schema fragment(s) for this class:
static class	BookingRules.BookingRule.CheckoutCharge The charges that may apply to an early or late checkout.

Constructor Summary

BookingRules.BookingRule()

Method Summary

void	addCheckoutCharge(BookingRules.BookingRule.CheckoutCharge item) Add a 'CheckoutCharge' element item.
void	addDescription(Paragraph item) Add a 'Description' element item.
void	clearCheckoutCharges() Remove all 'CheckoutCharge' element items.
void	clearDescriptions() Remove all 'Description' element items.
java.lang.String	getAbsoluteDropTime() Get the 'AbsoluteDropTime' attribute value.
BookingRules.BookingRule.AcceptableGuarantees	getAcceptableGuarantees() Get the 'AcceptableGuarantees' element value.
java.lang.Boolean	getAddressRequired() Get the 'AddressRequired' attribute value.
BookingRules.BookingRule.AddtionalRules	getAddtionalRules() Get the 'AddtionalRules' element value.
CancelPenalties	getCancelPenalties() Get the 'CancelPenalties' element value.
BookingRules.BookingRule.CheckoutCharge	getCheckoutCharge(int index) Get 'CheckoutCharge' element item by position.
java.util.List<BookingRules.BookingRule.CheckoutCharge>	getCheckoutCharges() Get the list of 'CheckoutCharge' element items.
CodeListGroup	getCodeListGroup() Get the 'CodeListGroup' attributeGroup value.
DateTimeSpanGroup	getDateTimeSpanGroup() Get the 'DateTimeSpanGroup' attributeGroup value.
java.lang.String	getDepositWaiverOffset() Get the 'DepositWaiverOffset' attribute value.
Paragraph	getDescription(int index) Get 'Description' element item by position.
java.util.List<Paragraph>	getDescriptions() Get the list of 'Description' element items.
DOWRestrictions	getDOWRestrictions() Get the 'DOW_Restrictions' element value.
java.lang.String	getForceGuaranteeOffset() Get the 'ForceGuaranteeOffset' attribute value.
java.lang.Boolean	getGenerallyBookable() Get the 'GenerallyBookable' attribute value.
InvBlockCutoffGroup	getInvBlockCutoffGroup() Get the 'InvBlockCutoffGroup' attributeGroup value.
LengthsOfStay	getLengthsOfStay() Get the 'LengthsOfStay' element value.
java.lang.String	getMaxAdvancedBookingOffset() Get the 'MaxAdvancedBookingOffset' attribute value.
java.lang.Integer	getMaxContiguousBookings() Get the 'MaxContiguousBookings' attribute value.
java.lang.Integer	getMaxTotalOccupancy() Get the 'MaxTotalOccupancy' attribute value.
java.lang.String	getMinAdvancedBookingOffset() Get the 'MinAdvancedBookingOffset' attribute value.
java.lang.Integer	getMinTotalOccupancy() Get the 'MinTotalOccupancy' attribute value.
java.lang.Boolean	getPriceViewable() Get the 'PriceViewable' attribute value.
java.lang.Boolean	getQualifiedRateYN() Get the 'QualifiedRateYN' attribute value.
RequiredPayments	getRequiredPaymts() Get the 'RequiredPaymts' element value.
RestrictionStatusGroup	getRestrictionStatus() Get the 'RestrictionStatusGroup' attributeGroup value.
UniqueID	getUniqueID() Get the 'UniqueID' element value.
Viewerships	getViewerships() Get the 'Viewerships' element value.
void	setAbsoluteDropTime(java.lang.String absoluteDropTime) Set the 'AbsoluteDropTime' attribute value.
void	setAcceptableGuarantees(BookingRules.BookingRule.AcceptableGuarantees acceptableGuarantees) Set the 'AcceptableGuarantees' element value.
void	setAddressRequired(java.lang.Boolean addressRequired) Set the 'AddressRequired' attribute value.
void	setAddtionalRules(BookingRules.BookingRule.AddtionalRules addtionalRules) Set the 'AddtionalRules' element value.
void	setCancelPenalties(CancelPenalties cancelPenalties) Set the 'CancelPenalties' element value.
void	setCheckoutCharges(java.util.List<BookingRules.BookingRule.CheckoutCharge> list) Set the list of 'CheckoutCharge' element items.
void	setCodeListGroup(CodeListGroup codeListGroup) Set the 'CodeListGroup' attributeGroup value.
void	setDateTimeSpanGroup(DateTimeSpanGroup dateTimeSpanGroup) Set the 'DateTimeSpanGroup' attributeGroup value.
void	setDepositWaiverOffset(java.lang.String depositWaiverOffset) Set the 'DepositWaiverOffset' attribute value.
void	setDescriptions(java.util.List<Paragraph> list) Set the list of 'Description' element items.
void	setDOWRestrictions(DOWRestrictions DOWRestrictions) Set the 'DOW_Restrictions' element value.
void	setForceGuaranteeOffset(java.lang.String forceGuaranteeOffset) Set the 'ForceGuaranteeOffset' attribute value.
void	setGenerallyBookable(java.lang.Boolean generallyBookable) Set the 'GenerallyBookable' attribute value.
void	setInvBlockCutoffGroup(InvBlockCutoffGroup invBlockCutoffGroup) Set the 'InvBlockCutoffGroup' attributeGroup value.
void	setLengthsOfStay(LengthsOfStay lengthsOfStay) Set the 'LengthsOfStay' element value.
void	setMaxAdvancedBookingOffset(java.lang.String maxAdvancedBookingOffset) Set the 'MaxAdvancedBookingOffset' attribute value.
void	setMaxContiguousBookings(java.lang.Integer maxContiguousBookings) Set the 'MaxContiguousBookings' attribute value.
void	setMaxTotalOccupancy(java.lang.Integer maxTotalOccupancy) Set the 'MaxTotalOccupancy' attribute value.
void	setMinAdvancedBookingOffset(java.lang.String minAdvancedBookingOffset) Set the 'MinAdvancedBookingOffset' attribute value.
void	setMinTotalOccupancy(java.lang.Integer minTotalOccupancy) Set the 'MinTotalOccupancy' attribute value.
void	setPriceViewable(java.lang.Boolean priceViewable) Set the 'PriceViewable' attribute value.
void	setQualifiedRateYN(java.lang.Boolean qualifiedRateYN) Set the 'QualifiedRateYN' attribute value.
void	setRequiredPaymts(RequiredPayments requiredPaymts) Set the 'RequiredPaymts' element value.
void	setRestrictionStatus(RestrictionStatusGroup restrictionStatus) Set the 'RestrictionStatusGroup' attributeGroup value.
void	setUniqueID(UniqueID uniqueID) Set the 'UniqueID' element value.
void	setViewerships(Viewerships viewerships) Set the 'Viewerships' element value.
int	sizeCheckoutCharges() Get the number of 'CheckoutCharge' element items.
int	sizeDescriptions() Get the number of 'Description' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

BookingRules.BookingRule

public BookingRules.BookingRule()

Method Detail

getAcceptableGuarantees

public BookingRules.BookingRule.AcceptableGuarantees getAcceptableGuarantees()

Get the 'AcceptableGuarantees' element value.

Returns:

value

setAcceptableGuarantees

public void setAcceptableGuarantees(BookingRules.BookingRule.AcceptableGuarantees acceptableGuarantees)

Set the 'AcceptableGuarantees' element value.

Parameters:

acceptableGuarantees -

getCancelPenalties

public CancelPenalties getCancelPenalties()

Get the 'CancelPenalties' element value. A collection of required payments that are part of the booking restriction.

Returns:

value

setCancelPenalties

public void setCancelPenalties(CancelPenalties cancelPenalties)

Set the 'CancelPenalties' element value. A collection of required payments that are part of the booking restriction.

Parameters:

cancelPenalties -

getRequiredPaymts

public RequiredPayments getRequiredPaymts()

Get the 'RequiredPaymts' element value. A collection of required payments that are part of the booking restriction.

Returns:

value

setRequiredPaymts

public void setRequiredPaymts(RequiredPayments requiredPaymts)

Set the 'RequiredPaymts' element value. A collection of required payments that are part of the booking restriction.

Parameters:

requiredPaymts -

getLengthsOfStay

public LengthsOfStay getLengthsOfStay()

Get the 'LengthsOfStay' element value. A collection of lengths of stay.

Returns:

value

setLengthsOfStay

public void setLengthsOfStay(LengthsOfStay lengthsOfStay)

Set the 'LengthsOfStay' element value. A collection of lengths of stay.

Parameters:

lengthsOfStay -

getDOWRestrictions

public DOWRestrictions getDOWRestrictions()

Get the 'DOW_Restrictions' element value. A collection of Day Of Week restrictions.

Returns:

value

setDOWRestrictions

public void setDOWRestrictions(DOWRestrictions DOWRestrictions)

Set the 'DOW_Restrictions' element value. A collection of Day Of Week restrictions.

Parameters:

DOWRestrictions -

getRestrictionStatus

public RestrictionStatusGroup getRestrictionStatus()

Get the 'RestrictionStatusGroup' attributeGroup value. Availability status assigned to the room rate combination for this booking rule.

Returns:

value

setRestrictionStatus

public void setRestrictionStatus(RestrictionStatusGroup restrictionStatus)

Set the 'RestrictionStatusGroup' attributeGroup value. Availability status assigned to the room rate combination for this booking rule.

Parameters:

restrictionStatus -

getViewerships

public Viewerships getViewerships()

Get the 'Viewerships' element value. A collection of Viewships.

Returns:

value

setViewerships

public void setViewerships(Viewerships viewerships)

Set the 'Viewerships' element value. A collection of Viewships.

Parameters:

viewerships -

getAddtionalRules

public BookingRules.BookingRule.AddtionalRules getAddtionalRules()

Get the 'AddtionalRules' element value.

Returns:

value

setAddtionalRules

public void setAddtionalRules(BookingRules.BookingRule.AddtionalRules addtionalRules)

Set the 'AddtionalRules' element value.

Parameters:

addtionalRules -

getDescriptions

public java.util.List<Paragraph> getDescriptions()

Get the list of 'Description' element items. General description of booking rule.

Returns:

list

setDescriptions

public void setDescriptions(java.util.List<Paragraph> list)

Set the list of 'Description' element items. General description of booking rule.

Parameters:

list -

sizeDescriptions

public int sizeDescriptions()

Get the number of 'Description' element items.

Returns:

count

addDescription

public void addDescription(Paragraph item)

Add a 'Description' element item.

Parameters:

item -

getDescription

public Paragraph getDescription(int index)

Get 'Description' element item by position.

Parameters:

index -

Returns:

item

clearDescriptions

public void clearDescriptions()

Remove all 'Description' element items.

getUniqueID

public UniqueID getUniqueID()

Get the 'UniqueID' element value. The unique identifier element allows the trading partners to uniquely identify each Booking Rule, for transaction tracability.

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 Booking Rule, for transaction tracability.

Parameters:

uniqueID -

getCheckoutCharges

public java.util.List<BookingRules.BookingRule.CheckoutCharge> getCheckoutCharges()

Get the list of 'CheckoutCharge' element items.

Returns:

list

setCheckoutCharges

public void setCheckoutCharges(java.util.List<BookingRules.BookingRule.CheckoutCharge> list)

Set the list of 'CheckoutCharge' element items.

Parameters:

list -

sizeCheckoutCharges

public int sizeCheckoutCharges()

Get the number of 'CheckoutCharge' element items.

Returns:

count

addCheckoutCharge

public void addCheckoutCharge(BookingRules.BookingRule.CheckoutCharge item)

Add a 'CheckoutCharge' element item.

Parameters:

item -

getCheckoutCharge

public BookingRules.BookingRule.CheckoutCharge getCheckoutCharge(int index)

Get 'CheckoutCharge' element item by position.

Parameters:

index -

Returns:

item

clearCheckoutCharges

public void clearCheckoutCharges()

Remove all 'CheckoutCharge' element items.

getCodeListGroup

public CodeListGroup getCodeListGroup()

Get the 'CodeListGroup' attributeGroup value. Used to specify a rate plan code, room type code or rate plan/room type combination code and its associated attributes.

Returns:

value

setCodeListGroup

public void setCodeListGroup(CodeListGroup codeListGroup)

Set the 'CodeListGroup' attributeGroup value. Used to specify a rate plan code, room type code or rate plan/room type combination code and its associated attributes.

Parameters:

codeListGroup -

getDateTimeSpanGroup

public DateTimeSpanGroup getDateTimeSpanGroup()

Get the 'DateTimeSpanGroup' attributeGroup value.

Returns:

value

setDateTimeSpanGroup

public void setDateTimeSpanGroup(DateTimeSpanGroup dateTimeSpanGroup)

Set the 'DateTimeSpanGroup' attributeGroup value.

Parameters:

dateTimeSpanGroup -

getMaxAdvancedBookingOffset

public java.lang.String getMaxAdvancedBookingOffset()

Get the 'MaxAdvancedBookingOffset' attribute value. Maximum days before the arrival date for which this rate plan may be booked.

Returns:

value

setMaxAdvancedBookingOffset

public void setMaxAdvancedBookingOffset(java.lang.String maxAdvancedBookingOffset)

Set the 'MaxAdvancedBookingOffset' attribute value. Maximum days before the arrival date for which this rate plan may be booked.

Parameters:

maxAdvancedBookingOffset -

getMinAdvancedBookingOffset

public java.lang.String getMinAdvancedBookingOffset()

Get the 'MinAdvancedBookingOffset' attribute value. Minimum days before the arrival date for which this rate plan may be booked.

Returns:

value

setMinAdvancedBookingOffset

public void setMinAdvancedBookingOffset(java.lang.String minAdvancedBookingOffset)

Set the 'MinAdvancedBookingOffset' attribute value. Minimum days before the arrival date for which this rate plan may be booked.

Parameters:

minAdvancedBookingOffset -

getForceGuaranteeOffset

public java.lang.String getForceGuaranteeOffset()

Get the 'ForceGuaranteeOffset' attribute value. Number of days prior to arrival date at which a guarantee is required.

Returns:

value

setForceGuaranteeOffset

public void setForceGuaranteeOffset(java.lang.String forceGuaranteeOffset)

Set the 'ForceGuaranteeOffset' attribute value. Number of days prior to arrival date at which a guarantee is required.

Parameters:

forceGuaranteeOffset -

getDepositWaiverOffset

public java.lang.String getDepositWaiverOffset()

Get the 'DepositWaiverOffset' attribute value. Number of days prior to arrival date for which a deposit is no longer accepted (because of a too short time delay between reservation and guest arrival).

Returns:

value

setDepositWaiverOffset

public void setDepositWaiverOffset(java.lang.String depositWaiverOffset)

Set the 'DepositWaiverOffset' attribute value. Number of days prior to arrival date for which a deposit is no longer accepted (because of a too short time delay between reservation and guest arrival).

Parameters:

depositWaiverOffset -

getMinTotalOccupancy

public java.lang.Integer getMinTotalOccupancy()

Get the 'MinTotalOccupancy' attribute value. Defines the minimum number of total occupants required for a rate plan.

Returns:

value

setMinTotalOccupancy

public void setMinTotalOccupancy(java.lang.Integer minTotalOccupancy)

Set the 'MinTotalOccupancy' attribute value. Defines the minimum number of total occupants required for a rate plan.

Parameters:

minTotalOccupancy -

getMaxTotalOccupancy

public java.lang.Integer getMaxTotalOccupancy()

Get the 'MaxTotalOccupancy' attribute value. Defines the maximum number of total occupants allowed for a rate plan.

Returns:

value

setMaxTotalOccupancy

public void setMaxTotalOccupancy(java.lang.Integer maxTotalOccupancy)

Set the 'MaxTotalOccupancy' attribute value. Defines the maximum number of total occupants allowed for a rate plan.

Parameters:

maxTotalOccupancy -

getAbsoluteDropTime

public java.lang.String getAbsoluteDropTime()

Get the 'AbsoluteDropTime' attribute value. The fixed time that the booking restriction goes into effect to cancel the non-guaranteed reservation. Either this attribute or the DropTimeOffset element may be used.

Returns:

value

setAbsoluteDropTime

public void setAbsoluteDropTime(java.lang.String absoluteDropTime)

Set the 'AbsoluteDropTime' attribute value. The fixed time that the booking restriction goes into effect to cancel the non-guaranteed reservation. Either this attribute or the DropTimeOffset element may be used.

Parameters:

absoluteDropTime -

getGenerallyBookable

public java.lang.Boolean getGenerallyBookable()

Get the 'GenerallyBookable' attribute value. Indicates whether this rate plan can be booked by those not in the viewership collection. If this attribute is False (0), then the viewerships collection lists those who have view-only or bookable status for this rate plan. If this attribute is True (1), then the viewerships collection lists those who have view-only or not-viewable status for this rate plan.

Returns:

value

setGenerallyBookable

public void setGenerallyBookable(java.lang.Boolean generallyBookable)

Set the 'GenerallyBookable' attribute value. Indicates whether this rate plan can be booked by those not in the viewership collection. If this attribute is False (0), then the viewerships collection lists those who have view-only or bookable status for this rate plan. If this attribute is True (1), then the viewerships collection lists those who have view-only or not-viewable status for this rate plan.

Parameters:

generallyBookable -

getPriceViewable

public java.lang.Boolean getPriceViewable()

Get the 'PriceViewable' attribute value. Indicates whether the price for this rate plan can be viewed, or whether the guest must contact another entity to obtain price information. Valid values: 0 = (No) Price Not Viewable, 1 = (Yes) Price Viewable.

Returns:

value

setPriceViewable

public void setPriceViewable(java.lang.Boolean priceViewable)

Set the 'PriceViewable' attribute value. Indicates whether the price for this rate plan can be viewed, or whether the guest must contact another entity to obtain price information. Valid values: 0 = (No) Price Not Viewable, 1 = (Yes) Price Viewable.

Parameters:

priceViewable -

getQualifiedRateYN

public java.lang.Boolean getQualifiedRateYN()

Get the 'QualifiedRateYN' attribute value. Boolean value indicating whether a specific rate plan must be qualified prior to inclusion in availability response messages.

Returns:

value

setQualifiedRateYN

public void setQualifiedRateYN(java.lang.Boolean qualifiedRateYN)

Set the 'QualifiedRateYN' attribute value. Boolean value indicating whether a specific rate plan must be qualified prior to inclusion in availability response messages.

Parameters:

qualifiedRateYN -

getAddressRequired

public java.lang.Boolean getAddressRequired()

Get the 'AddressRequired' attribute value. An address is required to complete the booking.

Returns:

value

setAddressRequired

public void setAddressRequired(java.lang.Boolean addressRequired)

Set the 'AddressRequired' attribute value. An address is required to complete the booking.

Parameters:

addressRequired -

getInvBlockCutoffGroup

public InvBlockCutoffGroup getInvBlockCutoffGroup()

Get the 'InvBlockCutoffGroup' attributeGroup value. Defines when block inventory is released back to general inventory.

Returns:

value

setInvBlockCutoffGroup

public void setInvBlockCutoffGroup(InvBlockCutoffGroup invBlockCutoffGroup)

Set the 'InvBlockCutoffGroup' attributeGroup value. Defines when block inventory is released back to general inventory.

Parameters:

invBlockCutoffGroup -

getMaxContiguousBookings

public java.lang.Integer getMaxContiguousBookings()

Get the 'MaxContiguousBookings' attribute value. The maximum number of times a rate may be booked contiguously within a reservation (often used with packages).

Returns:

value

setMaxContiguousBookings

public void setMaxContiguousBookings(java.lang.Integer maxContiguousBookings)

Set the 'MaxContiguousBookings' attribute value. The maximum number of times a rate may be booked contiguously within a reservation (often used with packages).

Parameters:

maxContiguousBookings -