org.ota.hotel
Class AvailGetRQ.HotelAvailRequest

java.lang.Object
  org.ota.hotel.AvailGetRQ.HotelAvailRequest

Enclosing class:

AvailGetRQ

public static class AvailGetRQ.HotelAvailRequest
extends java.lang.Object

Provides the criteria to specify availability details to return. The critiera can include date ranges, room and products, rate plans, hurdle rate, etc. 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="HotelAvailRequest" maxOccurs="unbounded">
   <xs:complexType>
     <xs:sequence>
       <xs:element name="DateRange" minOccurs="0">
         <xs:complexType>
           <xs:attributeGroup ref="ns:DateTimeSpanGroup"/>
         </xs:complexType>
       </xs:element>
       <xs:element type="ns:DestinationSystemCodesType" name="DestinationSystemsCode" minOccurs="0"/>
       <xs:element type="ns:RatePlanCandidatesType" name="RatePlanCandidates" minOccurs="0"/>
       <xs:element name="RoomTypeCandidates" minOccurs="0">
         <!-- Reference to inner class RoomTypeCandidates -->
       </xs:element>
       <xs:element name="Offers" minOccurs="0">
         <!-- Reference to inner class Offers -->
       </xs:element>
       <xs:element name="RestrictionStatusCandidates" minOccurs="0">
         <!-- Reference to inner class RestrictionStatusCandidates -->
       </xs:element>
       <xs:element name="LengthsOfStayCandidates" minOccurs="0">
         <!-- Reference to inner class LengthsOfStayCandidates -->
       </xs:element>
       <xs:element name="BestAvailableRateCandidate" minOccurs="0">
         <!-- Reference to inner class BestAvailableRateCandidate -->
       </xs:element>
       <xs:element name="HurdleRateCandidate" minOccurs="0">
         <!-- Reference to inner class HurdleRateCandidate -->
       </xs:element>
       <xs:element name="DeltaCandidate" minOccurs="0">
         <!-- Reference to inner class DeltaCandidate -->
       </xs:element>
       <xs:element name="HotelRef" minOccurs="0">
         <!-- Reference to inner class HotelRef -->
       </xs:element>
       <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute type="xs:boolean" name="SendBookingLimit"/>
     <xs:attribute use="optional" name="BookingLimitMessageType">
       <xs:simpleType>
         <!-- Reference to inner class BookingLimitMessage -->
       </xs:simpleType>
     </xs:attribute>
   </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

static class	AvailGetRQ.HotelAvailRequest.BestAvailableRateCandidate Use to request Best Available Rate Schema fragment(s) for this class:
static class	AvailGetRQ.HotelAvailRequest.BookingLimitMessage Schema fragment(s) for this class:
static class	AvailGetRQ.HotelAvailRequest.DeltaCandidate Use to request Delta Schema fragment(s) for this class:
static class	AvailGetRQ.HotelAvailRequest.HotelRef Indicates the detail of hotel reference information.
static class	AvailGetRQ.HotelAvailRequest.HurdleRateCandidate Use to request Hurdle Rates Schema fragment(s) for this class:
static class	AvailGetRQ.HotelAvailRequest.LengthsOfStayCandidates Collection of Length of Stay elements.
static class	AvailGetRQ.HotelAvailRequest.Offers Collection of requested offers.
static class	AvailGetRQ.HotelAvailRequest.RestrictionStatusCandidates A collection of Restriction Status values.
static class	AvailGetRQ.HotelAvailRequest.RoomTypeCandidates Collection of room stay candidates.

Constructor Summary

AvailGetRQ.HotelAvailRequest()

Method Summary

AvailGetRQ.HotelAvailRequest.BestAvailableRateCandidate	getBestAvailableRateCandidate() Get the 'BestAvailableRateCandidate' element value.
AvailGetRQ.HotelAvailRequest.BookingLimitMessage	getBookingLimitMessage() Get the 'BookingLimitMessageType' attribute value.
DateTimeSpanGroup	getDateRange() Get the 'DateTimeSpanGroup' attributeGroup value.
AvailGetRQ.HotelAvailRequest.DeltaCandidate	getDeltaCandidate() Get the 'DeltaCandidate' element value.
DestinationSystemCodes	getDestinationSystemsCode() Get the 'DestinationSystemsCode' element value.
AvailGetRQ.HotelAvailRequest.HotelRef	getHotelRef() Get the 'HotelRef' element value.
AvailGetRQ.HotelAvailRequest.HurdleRateCandidate	getHurdleRateCandidate() Get the 'HurdleRateCandidate' element value.
AvailGetRQ.HotelAvailRequest.LengthsOfStayCandidates	getLengthsOfStayCandidates() Get the 'LengthsOfStayCandidates' element value.
AvailGetRQ.HotelAvailRequest.Offers	getOffers() Get the 'Offers' element value.
RatePlanCandidates	getRatePlanCandidates() Get the 'RatePlanCandidates' element value.
AvailGetRQ.HotelAvailRequest.RestrictionStatusCandidates	getRestrictionStatusCandidates() Get the 'RestrictionStatusCandidates' element value.
AvailGetRQ.HotelAvailRequest.RoomTypeCandidates	getRoomTypeCandidates() Get the 'RoomTypeCandidates' element value.
java.lang.Boolean	getSendBookingLimit() Get the 'SendBookingLimit' attribute value.
TPAExtensions	getTPAExtensions() Get the 'TPA_Extensions' element value.
void	setBestAvailableRateCandidate(AvailGetRQ.HotelAvailRequest.BestAvailableRateCandidate bestAvailableRateCandidate) Set the 'BestAvailableRateCandidate' element value.
void	setBookingLimitMessage(AvailGetRQ.HotelAvailRequest.BookingLimitMessage bookingLimitMessage) Set the 'BookingLimitMessageType' attribute value.
void	setDateRange(DateTimeSpanGroup dateRange) Set the 'DateTimeSpanGroup' attributeGroup value.
void	setDeltaCandidate(AvailGetRQ.HotelAvailRequest.DeltaCandidate deltaCandidate) Set the 'DeltaCandidate' element value.
void	setDestinationSystemsCode(DestinationSystemCodes destinationSystemsCode) Set the 'DestinationSystemsCode' element value.
void	setHotelRef(AvailGetRQ.HotelAvailRequest.HotelRef hotelRef) Set the 'HotelRef' element value.
void	setHurdleRateCandidate(AvailGetRQ.HotelAvailRequest.HurdleRateCandidate hurdleRateCandidate) Set the 'HurdleRateCandidate' element value.
void	setLengthsOfStayCandidates(AvailGetRQ.HotelAvailRequest.LengthsOfStayCandidates lengthsOfStayCandidates) Set the 'LengthsOfStayCandidates' element value.
void	setOffers(AvailGetRQ.HotelAvailRequest.Offers offers) Set the 'Offers' element value.
void	setRatePlanCandidates(RatePlanCandidates ratePlanCandidates) Set the 'RatePlanCandidates' element value.
void	setRestrictionStatusCandidates(AvailGetRQ.HotelAvailRequest.RestrictionStatusCandidates restrictionStatusCandidates) Set the 'RestrictionStatusCandidates' element value.
void	setRoomTypeCandidates(AvailGetRQ.HotelAvailRequest.RoomTypeCandidates roomTypeCandidates) Set the 'RoomTypeCandidates' element value.
void	setSendBookingLimit(java.lang.Boolean sendBookingLimit) Set the 'SendBookingLimit' attribute value.
void	setTPAExtensions(TPAExtensions TPAExtensions) Set the 'TPA_Extensions' element value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailGetRQ.HotelAvailRequest

public AvailGetRQ.HotelAvailRequest()

Method Detail

getDateRange

public DateTimeSpanGroup getDateRange()

Get the 'DateTimeSpanGroup' attributeGroup value. A date or range of dates for the request criteria.

Returns:

value

setDateRange

public void setDateRange(DateTimeSpanGroup dateRange)

Set the 'DateTimeSpanGroup' attributeGroup value. A date or range of dates for the request criteria.

Parameters:

dateRange -

getDestinationSystemsCode

public DestinationSystemCodes getDestinationSystemsCode()

Get the 'DestinationSystemsCode' element value. A collection of destination system codes. These are systems for which this request is targeted.

Returns:

value

setDestinationSystemsCode

public void setDestinationSystemsCode(DestinationSystemCodes destinationSystemsCode)

Set the 'DestinationSystemsCode' element value. A collection of destination system codes. These are systems for which this request is targeted.

Parameters:

destinationSystemsCode -

getRatePlanCandidates

public RatePlanCandidates getRatePlanCandidates()

Get the 'RatePlanCandidates' element value. Collection of requested rate plans

Returns:

value

setRatePlanCandidates

public void setRatePlanCandidates(RatePlanCandidates ratePlanCandidates)

Set the 'RatePlanCandidates' element value. Collection of requested rate plans

Parameters:

ratePlanCandidates -

getRoomTypeCandidates

public AvailGetRQ.HotelAvailRequest.RoomTypeCandidates getRoomTypeCandidates()

Get the 'RoomTypeCandidates' element value.

Returns:

value

setRoomTypeCandidates

public void setRoomTypeCandidates(AvailGetRQ.HotelAvailRequest.RoomTypeCandidates roomTypeCandidates)

Set the 'RoomTypeCandidates' element value.

Parameters:

roomTypeCandidates -

getOffers

public AvailGetRQ.HotelAvailRequest.Offers getOffers()

Get the 'Offers' element value.

Returns:

value

setOffers

public void setOffers(AvailGetRQ.HotelAvailRequest.Offers offers)

Set the 'Offers' element value.

Parameters:

offers -

getRestrictionStatusCandidates

public AvailGetRQ.HotelAvailRequest.RestrictionStatusCandidates getRestrictionStatusCandidates()

Get the 'RestrictionStatusCandidates' element value.

Returns:

value

setRestrictionStatusCandidates

public void setRestrictionStatusCandidates(AvailGetRQ.HotelAvailRequest.RestrictionStatusCandidates restrictionStatusCandidates)

Set the 'RestrictionStatusCandidates' element value.

Parameters:

restrictionStatusCandidates -

getLengthsOfStayCandidates

public AvailGetRQ.HotelAvailRequest.LengthsOfStayCandidates getLengthsOfStayCandidates()

Get the 'LengthsOfStayCandidates' element value.

Returns:

value

setLengthsOfStayCandidates

public void setLengthsOfStayCandidates(AvailGetRQ.HotelAvailRequest.LengthsOfStayCandidates lengthsOfStayCandidates)

Set the 'LengthsOfStayCandidates' element value.

Parameters:

lengthsOfStayCandidates -

getBestAvailableRateCandidate

public AvailGetRQ.HotelAvailRequest.BestAvailableRateCandidate getBestAvailableRateCandidate()

Get the 'BestAvailableRateCandidate' element value.

Returns:

value

setBestAvailableRateCandidate

public void setBestAvailableRateCandidate(AvailGetRQ.HotelAvailRequest.BestAvailableRateCandidate bestAvailableRateCandidate)

Set the 'BestAvailableRateCandidate' element value.

Parameters:

bestAvailableRateCandidate -

getHurdleRateCandidate

public AvailGetRQ.HotelAvailRequest.HurdleRateCandidate getHurdleRateCandidate()

Get the 'HurdleRateCandidate' element value.

Returns:

value

setHurdleRateCandidate

public void setHurdleRateCandidate(AvailGetRQ.HotelAvailRequest.HurdleRateCandidate hurdleRateCandidate)

Set the 'HurdleRateCandidate' element value.

Parameters:

hurdleRateCandidate -

getDeltaCandidate

public AvailGetRQ.HotelAvailRequest.DeltaCandidate getDeltaCandidate()

Get the 'DeltaCandidate' element value.

Returns:

value

setDeltaCandidate

public void setDeltaCandidate(AvailGetRQ.HotelAvailRequest.DeltaCandidate deltaCandidate)

Set the 'DeltaCandidate' element value.

Parameters:

deltaCandidate -

getHotelRef

public AvailGetRQ.HotelAvailRequest.HotelRef getHotelRef()

Get the 'HotelRef' element value.

Returns:

value

setHotelRef

public void setHotelRef(AvailGetRQ.HotelAvailRequest.HotelRef hotelRef)

Set the 'HotelRef' element value.

Parameters:

hotelRef -

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 -

getSendBookingLimit

public java.lang.Boolean getSendBookingLimit()

Get the 'SendBookingLimit' attribute value. Boolean Flag indicating if overbooking or allocation (defined by BookingLimitMessageType) is requested.

Returns:

value

setSendBookingLimit

public void setSendBookingLimit(java.lang.Boolean sendBookingLimit)

Set the 'SendBookingLimit' attribute value. Boolean Flag indicating if overbooking or allocation (defined by BookingLimitMessageType) is requested.

Parameters:

sendBookingLimit -

getBookingLimitMessage

public AvailGetRQ.HotelAvailRequest.BookingLimitMessage getBookingLimitMessage()

Get the 'BookingLimitMessageType' attribute value. An enumerated type defining the function of the booking limit message. Values: SetLimit (Allocation), AdjustLimit (Overbooking).

Returns:

value

setBookingLimitMessage

public void setBookingLimitMessage(AvailGetRQ.HotelAvailRequest.BookingLimitMessage bookingLimitMessage)

Set the 'BookingLimitMessageType' attribute value. An enumerated type defining the function of the booking limit message. Values: SetLimit (Allocation), AdjustLimit (Overbooking).

Parameters:

bookingLimitMessage -