org.ota.hotel
Class InvBlockRQ

java.lang.Object
  org.ota.hotel.InvBlockRQ

public class InvBlockRQ
extends java.lang.Object

Provides the ability to request inventory block details for hotel properties by specific criteria that may include dates, date ranges, rooms and products. 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_HotelInvBlockRQ">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:POS_Type" name="POS" minOccurs="0"/>
       <xs:element name="HotelInvBlockRequests">
         <xs:complexType>
           <xs:sequence>
             <xs:element name="HotelInvBlockRequest" maxOccurs="unbounded">
               <!-- Reference to inner class HotelInvBlockRequest -->
             </xs:element>
           </xs:sequence>
         </xs:complexType>
       </xs:element>
     </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:string" use="optional" name="RequestedCurrency"/>
     <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:float" use="optional" name="MaximumWaitTime"/>
     <xs:attribute type="xs:string" use="optional" name="MoreDataEchoToken"/>
     <xs:attribute type="xs:string" use="optional" name="InfoSource"/>
   </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	InvBlockRQ.HotelInvBlockRequest Provides the criteria to identify the date range, inventory blocks and hotels to be returned.
static class	InvBlockRQ.SearchCacheLevel Schema fragment(s) for this class:
static class	InvBlockRQ.SortOrder Schema fragment(s) for this class:

Constructor Summary

InvBlockRQ()

Method Summary

void	addHotelInvBlockRequest(InvBlockRQ.HotelInvBlockRequest item) Add a 'HotelInvBlockRequest' element item.
void	clearHotelInvBlockRequests() Remove all 'HotelInvBlockRequest' element items.
InvBlockRQ.HotelInvBlockRequest	getHotelInvBlockRequest(int index) Get 'HotelInvBlockRequest' element item by position.
java.util.List<InvBlockRQ.HotelInvBlockRequest>	getHotelInvBlockRequests() Get the list of 'HotelInvBlockRequest' element items.
java.lang.String	getInfoSource() Get the 'InfoSource' attribute value.
java.lang.Float	getMaximumWaitTime() Get the 'MaximumWaitTime' attribute value.
java.lang.String	getMaxResponses() Get the 'MaxResponses' attribute value.
java.lang.String	getMoreDataEchoToken() Get the 'MoreDataEchoToken' attribute value.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
POS	getPOS() Get the 'POS' element value.
java.lang.String	getRequestedCurrency() Get the 'RequestedCurrency' attribute value.
InvBlockRQ.SearchCacheLevel	getSearchCacheLevel() Get the 'SearchCacheLevel' attribute value.
InvBlockRQ.SortOrder	getSortOrder() Get the 'SortOrder' attribute value.
java.lang.Boolean	getSummaryOnly() Get the 'SummaryOnly' attribute value.
void	setHotelInvBlockRequests(java.util.List<InvBlockRQ.HotelInvBlockRequest> list) Set the list of 'HotelInvBlockRequest' element items.
void	setInfoSource(java.lang.String infoSource) Set the 'InfoSource' attribute value.
void	setMaximumWaitTime(java.lang.Float maximumWaitTime) Set the 'MaximumWaitTime' attribute value.
void	setMaxResponses(java.lang.String maxResponses) Set the 'MaxResponses' attribute value.
void	setMoreDataEchoToken(java.lang.String moreDataEchoToken) Set the 'MoreDataEchoToken' attribute value.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setPOS(POS POS) Set the 'POS' element value.
void	setRequestedCurrency(java.lang.String requestedCurrency) Set the 'RequestedCurrency' attribute value.
void	setSearchCacheLevel(InvBlockRQ.SearchCacheLevel searchCacheLevel) Set the 'SearchCacheLevel' attribute value.
void	setSortOrder(InvBlockRQ.SortOrder sortOrder) Set the 'SortOrder' attribute value.
void	setSummaryOnly(java.lang.Boolean summaryOnly) Set the 'SummaryOnly' attribute value.
int	sizeHotelInvBlockRequests() Get the number of 'HotelInvBlockRequest' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

InvBlockRQ

public InvBlockRQ()

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 -

getHotelInvBlockRequests

public java.util.List<InvBlockRQ.HotelInvBlockRequest> getHotelInvBlockRequests()

Get the list of 'HotelInvBlockRequest' element items. Collection of Inventory Block requests criteria.

Returns:

list

setHotelInvBlockRequests

public void setHotelInvBlockRequests(java.util.List<InvBlockRQ.HotelInvBlockRequest> list)

Set the list of 'HotelInvBlockRequest' element items. Collection of Inventory Block requests criteria.

Parameters:

list -

sizeHotelInvBlockRequests

public int sizeHotelInvBlockRequests()

Get the number of 'HotelInvBlockRequest' element items.

Returns:

count

addHotelInvBlockRequest

public void addHotelInvBlockRequest(InvBlockRQ.HotelInvBlockRequest item)

Add a 'HotelInvBlockRequest' element item.

Parameters:

item -

getHotelInvBlockRequest

public InvBlockRQ.HotelInvBlockRequest getHotelInvBlockRequest(int index)

Get 'HotelInvBlockRequest' element item by position.

Parameters:

index -

Returns:

item

clearHotelInvBlockRequests

public void clearHotelInvBlockRequests()

Remove all 'HotelInvBlockRequest' element items.

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 InvBlockRQ.SortOrder getSortOrder()

Get the 'SortOrder' attribute value.

Returns:

value

setSortOrder

public void setSortOrder(InvBlockRQ.SortOrder sortOrder)

Set the 'SortOrder' attribute value.

Parameters:

sortOrder -

getRequestedCurrency

public java.lang.String getRequestedCurrency()

Get the 'RequestedCurrency' attribute value.

Returns:

value

setRequestedCurrency

public void setRequestedCurrency(java.lang.String requestedCurrency)

Set the 'RequestedCurrency' attribute value.

Parameters:

requestedCurrency -

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 InvBlockRQ.SearchCacheLevel getSearchCacheLevel()

Get the 'SearchCacheLevel' attribute value.

Returns:

value

setSearchCacheLevel

public void setSearchCacheLevel(InvBlockRQ.SearchCacheLevel searchCacheLevel)

Set the 'SearchCacheLevel' attribute value.

Parameters:

searchCacheLevel -

getMaximumWaitTime

public java.lang.Float getMaximumWaitTime()

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 'RatePlanRequestSegment' 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

setMaximumWaitTime

public void setMaximumWaitTime(java.lang.Float maximumWaitTime)

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 'RatePlanRequestSegment' 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:

maximumWaitTime -

getMoreDataEchoToken

public java.lang.String getMoreDataEchoToken()

Get the 'MoreDataEchoToken' attribute value. The response to the previous request returns this attribute if there was more data than could be returned in the response. Including the attribute in this request indicates where to begin the next block of data.

Returns:

value

setMoreDataEchoToken

public void setMoreDataEchoToken(java.lang.String moreDataEchoToken)

Set the 'MoreDataEchoToken' attribute value. The response to the previous request returns this attribute if there was more data than could be returned in the response. Including the attribute in this request indicates where to begin the next block of data.

Parameters:

moreDataEchoToken -

getInfoSource

public java.lang.String getInfoSource()

Get the 'InfoSource' attribute value. Used to specify the source of the data being exchanged as determined by trading partners.

Returns:

value

setInfoSource

public void setInfoSource(java.lang.String infoSource)

Set the 'InfoSource' attribute value. Used to specify the source of the data being exchanged as determined by trading partners.

Parameters:

infoSource -