org.ota.hotel
Class AvailRequestSegments.AvailRequestSegment

java.lang.Object
  org.ota.hotel.AvailRequestSegments.AvailRequestSegment

Enclosing class:

AvailRequestSegments

public static class AvailRequestSegments.AvailRequestSegment
extends java.lang.Object

To accommodate the ability to perform multiple requests within one message, the availability request contains the repeating element, AvailRequestSegment. Each segment includes a collection of criteria that requests a bookable entity, which may include designated rate plans, room types, amenities or services, and the request can be used for guest rooms or other inventory items for which availability is sought. Each segment would be presumed to have a unique date range for each request. 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="AvailRequestSegment" maxOccurs="unbounded">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:DateTimeSpanType" name="StayDateRange" minOccurs="0"/>
       <xs:element name="RateRange" minOccurs="0" maxOccurs="5">
         <!-- Reference to inner class RateRange -->
       </xs:element>
       <xs:element type="ns:RatePlanCandidatesType" name="RatePlanCandidates" minOccurs="0"/>
       <xs:element type="ns:ProfilesType" name="Profiles" minOccurs="0"/>
       <xs:element name="RoomStayCandidates" minOccurs="0">
         <!-- Reference to inner class RoomStayCandidates -->
       </xs:element>
       <xs:element type="ns:HotelSearchCriteriaType" name="HotelSearchCriteria" minOccurs="0"/>
       <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
     </xs:sequence>
     <xs:attribute name="AvailReqType">
       <xs:simpleType>
         <!-- Reference to inner class AvailReq -->
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute type="xs:string" name="MoreDataEchoToken"/>
     <xs:attributeGroup ref="ns:ResponseTypeGroup"/>
     <xs:attribute type="xs:string" use="optional" name="InfoSource"/>
   </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	AvailRequestSegments.AvailRequestSegment.AvailReq Schema fragment(s) for this class:
static class	AvailRequestSegments.AvailRequestSegment.RateRange Requested rate or rate range.
static class	AvailRequestSegments.AvailRequestSegment.RoomStayCandidates Collection of room stay candidates.

Constructor Summary

AvailRequestSegments.AvailRequestSegment()

Method Summary

void	addRateRange(AvailRequestSegments.AvailRequestSegment.RateRange item) Add a 'RateRange' element item.
void	clearRateRanges() Remove all 'RateRange' element items.
AvailRequestSegments.AvailRequestSegment.AvailReq	getAvailReq() Get the 'AvailReqType' attribute value.
HotelSearchCriteria	getHotelSearchCriteria() Get the 'HotelSearchCriteria' element value.
java.lang.String	getInfoSource() Get the 'InfoSource' attribute value.
java.lang.String	getMoreDataEchoToken() Get the 'MoreDataEchoToken' attribute value.
Profiles	getProfiles() Get the 'Profiles' element value.
RatePlanCandidates	getRatePlanCandidates() Get the 'RatePlanCandidates' element value.
AvailRequestSegments.AvailRequestSegment.RateRange	getRateRange(int index) Get 'RateRange' element item by position.
java.util.List<AvailRequestSegments.AvailRequestSegment.RateRange>	getRateRanges() Get the list of 'RateRange' element items.
ResponseTypeGroup	getResponseTypeGroup() Get the 'ResponseTypeGroup' attributeGroup value.
AvailRequestSegments.AvailRequestSegment.RoomStayCandidates	getRoomStayCandidates() Get the 'RoomStayCandidates' element value.
DateTimeSpan	getStayDateRange() Get the 'StayDateRange' element value.
TPAExtensions	getTPAExtensions() Get the 'TPA_Extensions' element value.
void	setAvailReq(AvailRequestSegments.AvailRequestSegment.AvailReq availReq) Set the 'AvailReqType' attribute value.
void	setHotelSearchCriteria(HotelSearchCriteria hotelSearchCriteria) Set the 'HotelSearchCriteria' element value.
void	setInfoSource(java.lang.String infoSource) Set the 'InfoSource' attribute value.
void	setMoreDataEchoToken(java.lang.String moreDataEchoToken) Set the 'MoreDataEchoToken' attribute value.
void	setProfiles(Profiles profiles) Set the 'Profiles' element value.
void	setRatePlanCandidates(RatePlanCandidates ratePlanCandidates) Set the 'RatePlanCandidates' element value.
void	setRateRanges(java.util.List<AvailRequestSegments.AvailRequestSegment.RateRange> list) Set the list of 'RateRange' element items.
void	setResponseTypeGroup(ResponseTypeGroup responseTypeGroup) Set the 'ResponseTypeGroup' attributeGroup value.
void	setRoomStayCandidates(AvailRequestSegments.AvailRequestSegment.RoomStayCandidates roomStayCandidates) Set the 'RoomStayCandidates' element value.
void	setStayDateRange(DateTimeSpan stayDateRange) Set the 'StayDateRange' element value.
void	setTPAExtensions(TPAExtensions TPAExtensions) Set the 'TPA_Extensions' element value.
int	sizeRateRanges() Get the number of 'RateRange' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailRequestSegments.AvailRequestSegment

public AvailRequestSegments.AvailRequestSegment()

Method Detail

getStayDateRange

public DateTimeSpan getStayDateRange()

Get the 'StayDateRange' element value. Range of dates, or fixed set of dates for Availability Request. Date range can also be specified by using start dates and number of nights (minimum, maximum or fixed). **This element is maintained at this level to support those who have implemented this message prior to 2005B. For new implementations consider using this element under HotelSearchCriteria.**

Returns:

value

setStayDateRange

public void setStayDateRange(DateTimeSpan stayDateRange)

Set the 'StayDateRange' element value. Range of dates, or fixed set of dates for Availability Request. Date range can also be specified by using start dates and number of nights (minimum, maximum or fixed). **This element is maintained at this level to support those who have implemented this message prior to 2005B. For new implementations consider using this element under HotelSearchCriteria.**

Parameters:

stayDateRange -

getRateRanges

public java.util.List<AvailRequestSegments.AvailRequestSegment.RateRange> getRateRanges()

Get the list of 'RateRange' element items.

Returns:

list

setRateRanges

public void setRateRanges(java.util.List<AvailRequestSegments.AvailRequestSegment.RateRange> list)

Set the list of 'RateRange' element items.

Parameters:

list -

sizeRateRanges

public int sizeRateRanges()

Get the number of 'RateRange' element items.

Returns:

count

addRateRange

public void addRateRange(AvailRequestSegments.AvailRequestSegment.RateRange item)

Add a 'RateRange' element item.

Parameters:

item -

getRateRange

public AvailRequestSegments.AvailRequestSegment.RateRange getRateRange(int index)

Get 'RateRange' element item by position.

Parameters:

index -

Returns:

item

clearRateRanges

public void clearRateRanges()

Remove all 'RateRange' element items.

getRatePlanCandidates

public RatePlanCandidates getRatePlanCandidates()

Get the 'RatePlanCandidates' element value. **This element is maintained at this level to support those who have implemented this message prior to 2005B. For new implementations consider using this element under HotelSearchCriteria.**

Returns:

value

setRatePlanCandidates

public void setRatePlanCandidates(RatePlanCandidates ratePlanCandidates)

Set the 'RatePlanCandidates' element value. **This element is maintained at this level to support those who have implemented this message prior to 2005B. For new implementations consider using this element under HotelSearchCriteria.**

Parameters:

ratePlanCandidates -

getProfiles

public Profiles getProfiles()

Get the 'Profiles' element value. A collection of profile objects or unique IDs of profiles. This element is maintained at this level to support those who have implemented this message prior to 2005B. For new implementations consider using this element under HotelSearchCriteria.**

Returns:

value

setProfiles

public void setProfiles(Profiles profiles)

Set the 'Profiles' element value. A collection of profile objects or unique IDs of profiles. This element is maintained at this level to support those who have implemented this message prior to 2005B. For new implementations consider using this element under HotelSearchCriteria.**

Parameters:

profiles -

getRoomStayCandidates

public AvailRequestSegments.AvailRequestSegment.RoomStayCandidates getRoomStayCandidates()

Get the 'RoomStayCandidates' element value.

Returns:

value

setRoomStayCandidates

public void setRoomStayCandidates(AvailRequestSegments.AvailRequestSegment.RoomStayCandidates roomStayCandidates)

Set the 'RoomStayCandidates' element value.

Parameters:

roomStayCandidates -

getHotelSearchCriteria

public HotelSearchCriteria getHotelSearchCriteria()

Get the 'HotelSearchCriteria' element value.

Returns:

value

setHotelSearchCriteria

public void setHotelSearchCriteria(HotelSearchCriteria hotelSearchCriteria)

Set the 'HotelSearchCriteria' element value.

Parameters:

hotelSearchCriteria -

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 -

getAvailReq

public AvailRequestSegments.AvailRequestSegment.AvailReq getAvailReq()

Get the 'AvailReqType' attribute value. An enumerated type that indicates whether the availability request is for a room or non-room product, such as amenities or other activities (e.g.: banquet, conference room, etc.). Values: Room, NonRoom, Both.

Returns:

value

setAvailReq

public void setAvailReq(AvailRequestSegments.AvailRequestSegment.AvailReq availReq)

Set the 'AvailReqType' attribute value. An enumerated type that indicates whether the availability request is for a room or non-room product, such as amenities or other activities (e.g.: banquet, conference room, etc.). Values: Room, NonRoom, Both.

Parameters:

availReq -

getMoreDataEchoToken

public java.lang.String getMoreDataEchoToken()

Get the 'MoreDataEchoToken' attribute value. The availability response returns the attribute if there were additional rates that could not fit within the availability response. The text value should be echoed in this availability request to indicate where to begin the next block of availability data.

Returns:

value

setMoreDataEchoToken

public void setMoreDataEchoToken(java.lang.String moreDataEchoToken)

Set the 'MoreDataEchoToken' attribute value. The availability response returns the attribute if there were additional rates that could not fit within the availability response. The text value should be echoed in this availability request to indicate where to begin the next block of availability data.

Parameters:

moreDataEchoToken -

getResponseTypeGroup

public ResponseTypeGroup getResponseTypeGroup()

Get the 'ResponseTypeGroup' attributeGroup value.

Returns:

value

setResponseTypeGroup

public void setResponseTypeGroup(ResponseTypeGroup responseTypeGroup)

Set the 'ResponseTypeGroup' attributeGroup value.

Parameters:

responseTypeGroup -

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 -