org.ota.hotel
Class InvBlockRQ.HotelInvBlockRequest

java.lang.Object
  extended by org.ota.hotel.InvBlockRQ.HotelInvBlockRequest
Enclosing class:
InvBlockRQ

public static class InvBlockRQ.HotelInvBlockRequest
extends java.lang.Object

Provides the criteria to identify the date range, inventory blocks and hotels to be returned. 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="HotelInvBlockRequest" 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:InvBlockType" name="InvBlock" minOccurs="0" maxOccurs="99"/>
       <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 type="xs:anySimpleType" name="IncludeAllBlocksAffectingDateRange"/>
     <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 InvBlockRQ.HotelInvBlockRequest.BookingLimitMessage
          Schema fragment(s) for this class:
static class InvBlockRQ.HotelInvBlockRequest.HotelRef
          Indicates the detail of hotel reference information.
 
Constructor Summary
InvBlockRQ.HotelInvBlockRequest()
           
 
Method Summary
 void addInvBlock(InvBlock item)
          Add a 'InvBlock' element item.
 void clearInvBlocks()
          Remove all 'InvBlock' element items.
 InvBlockRQ.HotelInvBlockRequest.BookingLimitMessage getBookingLimitMessage()
          Get the 'BookingLimitMessageType' attribute value.
 DateTimeSpanGroup getDateRange()
          Get the 'DateTimeSpanGroup' attributeGroup value.
 InvBlockRQ.HotelInvBlockRequest.HotelRef getHotelRef()
          Get the 'HotelRef' element value.
 java.lang.String getIncludeAllBlocksAffectingDateRange()
          Get the 'IncludeAllBlocksAffectingDateRange' attribute value.
 InvBlock getInvBlock(int index)
          Get 'InvBlock' element item by position.
 java.util.List<InvBlock> getInvBlocks()
          Get the list of 'InvBlock' element items.
 java.lang.Boolean getSendBookingLimit()
          Get the 'SendBookingLimit' attribute value.
 TPAExtensions getTPAExtensions()
          Get the 'TPA_Extensions' element value.
 void setBookingLimitMessage(InvBlockRQ.HotelInvBlockRequest.BookingLimitMessage bookingLimitMessage)
          Set the 'BookingLimitMessageType' attribute value.
 void setDateRange(DateTimeSpanGroup dateRange)
          Set the 'DateTimeSpanGroup' attributeGroup value.
 void setHotelRef(InvBlockRQ.HotelInvBlockRequest.HotelRef hotelRef)
          Set the 'HotelRef' element value.
 void setIncludeAllBlocksAffectingDateRange(java.lang.String includeAllBlocksAffectingDateRange)
          Set the 'IncludeAllBlocksAffectingDateRange' attribute value.
 void setInvBlocks(java.util.List<InvBlock> list)
          Set the list of 'InvBlock' element items.
 void setSendBookingLimit(java.lang.Boolean sendBookingLimit)
          Set the 'SendBookingLimit' attribute value.
 void setTPAExtensions(TPAExtensions TPAExtensions)
          Set the 'TPA_Extensions' element value.
 int sizeInvBlocks()
          Get the number of 'InvBlock' element items.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InvBlockRQ.HotelInvBlockRequest

public InvBlockRQ.HotelInvBlockRequest()
Method Detail

getDateRange

public DateTimeSpanGroup getDateRange()
Get the 'DateTimeSpanGroup' attributeGroup value. A date or range of dates for the rate plan.

Returns:
value

setDateRange

public void setDateRange(DateTimeSpanGroup dateRange)
Set the 'DateTimeSpanGroup' attributeGroup value. A date or range of dates for the rate plan.

Parameters:
dateRange -

getInvBlocks

public java.util.List<InvBlock> getInvBlocks()
Get the list of 'InvBlock' element items. This is for creating a single block at a single hotel.

Returns:
list

setInvBlocks

public void setInvBlocks(java.util.List<InvBlock> list)
Set the list of 'InvBlock' element items. This is for creating a single block at a single hotel.

Parameters:
list -

sizeInvBlocks

public int sizeInvBlocks()
Get the number of 'InvBlock' element items.

Returns:
count

addInvBlock

public void addInvBlock(InvBlock item)
Add a 'InvBlock' element item.

Parameters:
item -

getInvBlock

public InvBlock getInvBlock(int index)
Get 'InvBlock' element item by position.

Parameters:
index -
Returns:
item

clearInvBlocks

public void clearInvBlocks()
Remove all 'InvBlock' element items.


getHotelRef

public InvBlockRQ.HotelInvBlockRequest.HotelRef getHotelRef()
Get the 'HotelRef' element value.

Returns:
value

setHotelRef

public void setHotelRef(InvBlockRQ.HotelInvBlockRequest.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 -

getIncludeAllBlocksAffectingDateRange

public java.lang.String getIncludeAllBlocksAffectingDateRange()
Get the 'IncludeAllBlocksAffectingDateRange' attribute value. When true, include blocks which partially fall inside the requested date range but start or end outside the date range.

Returns:
value

setIncludeAllBlocksAffectingDateRange

public void setIncludeAllBlocksAffectingDateRange(java.lang.String includeAllBlocksAffectingDateRange)
Set the 'IncludeAllBlocksAffectingDateRange' attribute value. When true, include blocks which partially fall inside the requested date range but start or end outside the date range.

Parameters:
includeAllBlocksAffectingDateRange -

getBookingLimitMessage

public InvBlockRQ.HotelInvBlockRequest.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(InvBlockRQ.HotelInvBlockRequest.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 -