org.ota.hotel
Class AvailRQ

java.lang.Object
  org.ota.hotel.AvailRQ

public class AvailRQ
extends java.lang.Object

Requests availability of hotel properties by specific criteria that may include: dates, date ranges, price range, room types, regular and qualifying rates, and/or services and amenities. The availability message can be used to get an initial availability or to get availability for the purpose of modifying an existing reservation. 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="OTA_HotelAvailRQ">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:POS_Type" name="POS" minOccurs="0"/>
       <xs:element name="AvailRequestSegments">
         <xs:complexType>
           <xs:complexContent>
             <xs:extension base="ns:AvailRequestSegmentsType">
               <xs:attribute type="xs:float" use="optional" name="MaximumWaitTime"/>
             </xs:extension>
           </xs:complexContent>
         </xs:complexType>
       </xs:element>
       <xs:element type="ns:HotelReservationIDsType" name="HotelReservationIDs" minOccurs="0"/>
     </xs:sequence>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
     <xs:attribute type="xs:boolean" use="optional" name="SummaryOnly"/>
     <xs:attribute use="optional" name="SortOrder">
       <xs:simpleType>
         <!-- Reference to inner class SortOrder -->
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute type="xs:boolean" use="optional" name="AvailRatesOnly"/>
     <xs:attribute type="xs:boolean" use="optional" name="OnRequestInd"/>
     <xs:attribute type="xs:boolean" use="optional" name="BestOnly"/>
     <xs:attribute type="xs:boolean" use="optional" name="RateRangeOnly"/>
     <xs:attribute type="xs:boolean" use="optional" name="ExactMatchOnly"/>
     <xs:attribute type="xs:boolean" use="optional" name="AllowPartialAvail"/>
     <xs:attribute type="xs:string" use="optional" name="RequestedCurrency"/>
     <xs:attribute type="xs:boolean" use="optional" name="RequestedCurrencyIndicator"/>
     <xs:attribute type="xs:boolean" use="optional" name="IsModify"/>
     <xs:attributeGroup ref="ns:MaxResponsesGroup"/>
     <xs:attribute use="optional" name="SearchCacheLevel">
       <xs:simpleType>
         <!-- Reference to inner class SearchCacheLevel -->
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute type="xs:boolean" use="optional" name="HotelStayOnly"/>
     <xs:attribute type="xs:boolean" use="optional" name="RateDetailsInd"/>
   </xs:complexType>
 </xs:element>
 
 <xs:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="MaxResponsesGroup">
   <xs:attribute type="xs:string" use="optional" name="MaxResponses"/>
 </xs:attributeGroup>
 

Nested Class Summary

static class	AvailRQ.SearchCacheLevel Schema fragment(s) for this class:
static class	AvailRQ.SortOrder Schema fragment(s) for this class:

Constructor Summary

AvailRQ()

Method Summary

java.lang.Boolean	getAllowPartialAvail() Get the 'AllowPartialAvail' attribute value.
java.lang.Boolean	getAvailRatesOnly() Get the 'AvailRatesOnly' attribute value.
AvailRequestSegments	getAvailRequestSegmentsAvailRequestSegments() Get the extension value.
java.lang.Float	getAvailRequestSegmentsMaximumWaitTime() Get the 'MaximumWaitTime' attribute value.
java.lang.Boolean	getBestOnly() Get the 'BestOnly' attribute value.
java.lang.Boolean	getExactMatchOnly() Get the 'ExactMatchOnly' attribute value.
HotelReservationIDs	getHotelReservationIDs() Get the 'HotelReservationIDs' element value.
java.lang.Boolean	getHotelStayOnly() Get the 'HotelStayOnly' attribute value.
java.lang.Boolean	getIsModify() Get the 'IsModify' attribute value.
java.lang.String	getMaxResponses() Get the 'MaxResponses' attribute value.
java.lang.Boolean	getOnRequestInd() Get the 'OnRequestInd' attribute value.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
POS	getPOS() Get the 'POS' element value.
java.lang.Boolean	getRateDetailsInd() Get the 'RateDetailsInd' attribute value.
java.lang.Boolean	getRateRangeOnly() Get the 'RateRangeOnly' attribute value.
java.lang.String	getRequestedCurrency() Get the 'RequestedCurrency' attribute value.
java.lang.Boolean	getRequestedCurrencyIndicator() Get the 'RequestedCurrencyIndicator' attribute value.
AvailRQ.SearchCacheLevel	getSearchCacheLevel() Get the 'SearchCacheLevel' attribute value.
AvailRQ.SortOrder	getSortOrder() Get the 'SortOrder' attribute value.
java.lang.Boolean	getSummaryOnly() Get the 'SummaryOnly' attribute value.
void	setAllowPartialAvail(java.lang.Boolean allowPartialAvail) Set the 'AllowPartialAvail' attribute value.
void	setAvailRatesOnly(java.lang.Boolean availRatesOnly) Set the 'AvailRatesOnly' attribute value.
void	setAvailRequestSegmentsAvailRequestSegments(AvailRequestSegments availRequestSegmentsAvailRequestSegments) Set the extension value.
void	setAvailRequestSegmentsMaximumWaitTime(java.lang.Float availRequestSegmentsMaximumWaitTime) Set the 'MaximumWaitTime' attribute value.
void	setBestOnly(java.lang.Boolean bestOnly) Set the 'BestOnly' attribute value.
void	setExactMatchOnly(java.lang.Boolean exactMatchOnly) Set the 'ExactMatchOnly' attribute value.
void	setHotelReservationIDs(HotelReservationIDs hotelReservationIDs) Set the 'HotelReservationIDs' element value.
void	setHotelStayOnly(java.lang.Boolean hotelStayOnly) Set the 'HotelStayOnly' attribute value.
void	setIsModify(java.lang.Boolean isModify) Set the 'IsModify' attribute value.
void	setMaxResponses(java.lang.String maxResponses) Set the 'MaxResponses' attribute value.
void	setOnRequestInd(java.lang.Boolean onRequestInd) Set the 'OnRequestInd' attribute value.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setPOS(POS POS) Set the 'POS' element value.
void	setRateDetailsInd(java.lang.Boolean rateDetailsInd) Set the 'RateDetailsInd' attribute value.
void	setRateRangeOnly(java.lang.Boolean rateRangeOnly) Set the 'RateRangeOnly' attribute value.
void	setRequestedCurrency(java.lang.String requestedCurrency) Set the 'RequestedCurrency' attribute value.
void	setRequestedCurrencyIndicator(java.lang.Boolean requestedCurrencyIndicator) Set the 'RequestedCurrencyIndicator' attribute value.
void	setSearchCacheLevel(AvailRQ.SearchCacheLevel searchCacheLevel) Set the 'SearchCacheLevel' attribute value.
void	setSortOrder(AvailRQ.SortOrder sortOrder) Set the 'SortOrder' attribute value.
void	setSummaryOnly(java.lang.Boolean summaryOnly) Set the 'SummaryOnly' attribute value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailRQ

public AvailRQ()

Method Detail

getPOS

public POS getPOS()

Get the 'POS' element value. Point of sale object.

Returns:

value

setPOS

public void setPOS(POS POS)

Set the 'POS' element value. Point of sale object.

Parameters:

POS -

getAvailRequestSegmentsAvailRequestSegments

public AvailRequestSegments getAvailRequestSegmentsAvailRequestSegments()

Get the extension value.

Returns:

value

setAvailRequestSegmentsAvailRequestSegments

public void setAvailRequestSegmentsAvailRequestSegments(AvailRequestSegments availRequestSegmentsAvailRequestSegments)

Set the extension value.

Parameters:

availRequestSegmentsAvailRequestSegments -

getAvailRequestSegmentsMaximumWaitTime

public java.lang.Float getAvailRequestSegmentsMaximumWaitTime()

Get the 'MaximumWaitTime' attribute value. The value of this attribute will be a decimal field identifying the maximum number of seconds the responding application has to respond to the request. For example, suppose a client requests 10 OTA 'AvailRequestSegment' items but can only wait up to 4.0 seconds max. If only 6 segments were collected within the time-frame, the client would only receive those 6 segments within one response message.

Returns:

value

setAvailRequestSegmentsMaximumWaitTime

public void setAvailRequestSegmentsMaximumWaitTime(java.lang.Float availRequestSegmentsMaximumWaitTime)

Set the 'MaximumWaitTime' attribute value. The value of this attribute will be a decimal field identifying the maximum number of seconds the responding application has to respond to the request. For example, suppose a client requests 10 OTA 'AvailRequestSegment' items but can only wait up to 4.0 seconds max. If only 6 segments were collected within the time-frame, the client would only receive those 6 segments within one response message.

Parameters:

availRequestSegmentsMaximumWaitTime -

getHotelReservationIDs

public HotelReservationIDs getHotelReservationIDs()

Get the 'HotelReservationIDs' element value. Collection of Hotel Reservation IDs associated with a given reservation, used when asking for availability for the purpose of modifying an existing reservation.

Returns:

value

setHotelReservationIDs

public void setHotelReservationIDs(HotelReservationIDs hotelReservationIDs)

Set the 'HotelReservationIDs' element value. Collection of Hotel Reservation IDs associated with a given reservation, used when asking for availability for the purpose of modifying an existing reservation.

Parameters:

hotelReservationIDs -

getOTAPayloadStdAttributes

public OTAPayloadStdAttributes getOTAPayloadStdAttributes()

Get the 'OTA_PayloadStdAttributes' attributeGroup value.

Returns:

value

setOTAPayloadStdAttributes

public void setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes)

Set the 'OTA_PayloadStdAttributes' attributeGroup value.

Parameters:

OTAPayloadStdAttributes -

getSummaryOnly

public java.lang.Boolean getSummaryOnly()

Get the 'SummaryOnly' attribute value.

Returns:

value

setSummaryOnly

public void setSummaryOnly(java.lang.Boolean summaryOnly)

Set the 'SummaryOnly' attribute value.

Parameters:

summaryOnly -

getSortOrder

public AvailRQ.SortOrder getSortOrder()

Get the 'SortOrder' attribute value. A

Returns:

value

setSortOrder

public void setSortOrder(AvailRQ.SortOrder sortOrder)

Set the 'SortOrder' attribute value. A

Parameters:

sortOrder -

getAvailRatesOnly

public java.lang.Boolean getAvailRatesOnly()

Get the 'AvailRatesOnly' attribute value. A boolean flag that indicates the response should include ONLY those rates that are available in the date range specified, or whether rates that are NOT available should be shown. "Yes" returns only available rates; "No" returns all rates.

Returns:

value

setAvailRatesOnly

public void setAvailRatesOnly(java.lang.Boolean availRatesOnly)

Set the 'AvailRatesOnly' attribute value. A boolean flag that indicates the response should include ONLY those rates that are available in the date range specified, or whether rates that are NOT available should be shown. "Yes" returns only available rates; "No" returns all rates.

Parameters:

availRatesOnly -

getOnRequestInd

public java.lang.Boolean getOnRequestInd()

Get the 'OnRequestInd' attribute value. When true, the response should include rooms with an availability status of 'on request'. When false, the response should not include rooms with an availability status of 'on request'.

Returns:

value

setOnRequestInd

public void setOnRequestInd(java.lang.Boolean onRequestInd)

Set the 'OnRequestInd' attribute value. When true, the response should include rooms with an availability status of 'on request'. When false, the response should not include rooms with an availability status of 'on request'.

Parameters:

onRequestInd -

getBestOnly

public java.lang.Boolean getBestOnly()

Get the 'BestOnly' attribute value. A boolean flag that indicates the response message should send back only the best rate available at the hotel property, as there could be multiple room types and rates that meet the requested criteria (e.g.: rate range). Allowing that the term "best rate" is subjective, the intent means the lowest rate that meets the category of the input criteria, and may have the effect of limiting the return to one rate quote as opposed to multiples.

Returns:

value

setBestOnly

public void setBestOnly(java.lang.Boolean bestOnly)

Set the 'BestOnly' attribute value. A boolean flag that indicates the response message should send back only the best rate available at the hotel property, as there could be multiple room types and rates that meet the requested criteria (e.g.: rate range). Allowing that the term "best rate" is subjective, the intent means the lowest rate that meets the category of the input criteria, and may have the effect of limiting the return to one rate quote as opposed to multiples.

Parameters:

bestOnly -

getRateRangeOnly

public java.lang.Boolean getRateRangeOnly()

Get the 'RateRangeOnly' attribute value. A boolean flag that indicates the response message should send back only those rates that are available within the range of the minimum and maximum amount specified.

Returns:

value

setRateRangeOnly

public void setRateRangeOnly(java.lang.Boolean rateRangeOnly)

Set the 'RateRangeOnly' attribute value. A boolean flag that indicates the response message should send back only those rates that are available within the range of the minimum and maximum amount specified.

Parameters:

rateRangeOnly -

getExactMatchOnly

public java.lang.Boolean getExactMatchOnly()

Get the 'ExactMatchOnly' attribute value. A boolean flag that indicates the response message should send back only those rates that are an exact match to the requested criteria.

Returns:

value

setExactMatchOnly

public void setExactMatchOnly(java.lang.Boolean exactMatchOnly)

Set the 'ExactMatchOnly' attribute value. A boolean flag that indicates the response message should send back only those rates that are an exact match to the requested criteria.

Parameters:

exactMatchOnly -

getAllowPartialAvail

public java.lang.Boolean getAllowPartialAvail()

Get the 'AllowPartialAvail' attribute value. A boolean flag that indicates the response message should include availability and rates that do not span the complete stay.

Returns:

value

setAllowPartialAvail

public void setAllowPartialAvail(java.lang.Boolean allowPartialAvail)

Set the 'AllowPartialAvail' attribute value. A boolean flag that indicates the response message should include availability and rates that do not span the complete stay.

Parameters:

allowPartialAvail -

getRequestedCurrency

public java.lang.String getRequestedCurrency()

Get the 'RequestedCurrency' attribute value. The code specifying the currency in which the response should be sent. Use ISO 4217, three alpha code.

Returns:

value

setRequestedCurrency

public void setRequestedCurrency(java.lang.String requestedCurrency)

Set the 'RequestedCurrency' attribute value. The code specifying the currency in which the response should be sent. Use ISO 4217, three alpha code.

Parameters:

requestedCurrency -

getRequestedCurrencyIndicator

public java.lang.Boolean getRequestedCurrencyIndicator()

Get the 'RequestedCurrencyIndicator' attribute value. When true, indicates that response should only incude rates that match requested currency.

Returns:

value

setRequestedCurrencyIndicator

public void setRequestedCurrencyIndicator(java.lang.Boolean requestedCurrencyIndicator)

Set the 'RequestedCurrencyIndicator' attribute value. When true, indicates that response should only incude rates that match requested currency.

Parameters:

requestedCurrencyIndicator -

getIsModify

public java.lang.Boolean getIsModify()

Get the 'IsModify' attribute value. Indicates that this is an availibility request for a modification to an existing reservation. false

Returns:

value

setIsModify

public void setIsModify(java.lang.Boolean isModify)

Set the 'IsModify' attribute value. Indicates that this is an availibility request for a modification to an existing reservation. false

Parameters:

isModify -

getMaxResponses

public java.lang.String getMaxResponses()

Get the 'MaxResponses' attribute value. A positive integer value that indicates the maximum number of responses desired in the return.

Returns:

value

setMaxResponses

public void setMaxResponses(java.lang.String maxResponses)

Set the 'MaxResponses' attribute value. A positive integer value that indicates the maximum number of responses desired in the return.

Parameters:

maxResponses -

getSearchCacheLevel

public AvailRQ.SearchCacheLevel getSearchCacheLevel()

Get the 'SearchCacheLevel' attribute value.

Returns:

value

setSearchCacheLevel

public void setSearchCacheLevel(AvailRQ.SearchCacheLevel searchCacheLevel)

Set the 'SearchCacheLevel' attribute value.

Parameters:

searchCacheLevel -

getHotelStayOnly

public java.lang.Boolean getHotelStayOnly()

Get the 'HotelStayOnly' attribute value. A boolean flag that indicates the response message should return only HotelStay information. If true, no RoomStay information will be returned.

Returns:

value

setHotelStayOnly

public void setHotelStayOnly(java.lang.Boolean hotelStayOnly)

Set the 'HotelStayOnly' attribute value. A boolean flag that indicates the response message should return only HotelStay information. If true, no RoomStay information will be returned.

Parameters:

hotelStayOnly -

getRateDetailsInd

public java.lang.Boolean getRateDetailsInd()

Get the 'RateDetailsInd' attribute value. If true, the response message should contain room rate details.

Returns:

value

setRateDetailsInd

public void setRateDetailsInd(java.lang.Boolean rateDetailsInd)

Set the 'RateDetailsInd' attribute value. If true, the response message should contain room rate details.

Parameters:

rateDetailsInd -