org.ota.hotel
Class HotelSearchCriterion

java.lang.Object
  org.ota.shared.ItemSearchCriterion
      org.ota.hotel.HotelSearchCriterion

Direct Known Subclasses:

HotelSearchCriteria.Criterion

public class HotelSearchCriterion
extends ItemSearchCriterion

A collection of Profile objects or Unique IDs of Profiles. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="HotelSearchCriterionType">
   <xs:complexContent>
     <xs:extension base="ns:ItemSearchCriterionType">
       <xs:sequence>
         <xs:element name="HotelAmenity" minOccurs="0" maxOccurs="10">
           <!-- Reference to inner class HotelAmenity -->
         </xs:element>
         <xs:element type="ns:RoomAmenityPrefType" name="RoomAmenity" minOccurs="0" maxOccurs="5"/>
         <xs:element name="HotelFeature" minOccurs="0" maxOccurs="10">
           <!-- Reference to inner class HotelFeature -->
         </xs:element>
         <xs:element name="Award" minOccurs="0" maxOccurs="5">
           <!-- Reference to inner class Award -->
         </xs:element>
         <xs:element name="Recreation" minOccurs="0" maxOccurs="5">
           <!-- Reference to inner class Recreation -->
         </xs:element>
         <xs:element name="Service" minOccurs="0" maxOccurs="99">
           <!-- Reference to inner class Service -->
         </xs:element>
         <xs:element name="Transportation" minOccurs="0" maxOccurs="5">
           <!-- Reference to inner class Transportation -->
         </xs:element>
         <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:AcceptedPaymentsType" name="AcceptedPayments" minOccurs="0"/>
         <xs:element name="Media" minOccurs="0" maxOccurs="5">
           <!-- Reference to inner class Media -->
         </xs:element>
         <xs:element name="HotelMeetingFacility" minOccurs="0">
           <!-- Reference to inner class HotelMeetingFacility -->
         </xs:element>
         <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>
 
 <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	HotelSearchCriterion.Award An element that identifies the hotel ratings.
static class	HotelSearchCriterion.HotelAmenity Hotel level amenities for searches.
static class	HotelSearchCriterion.HotelFeature Used to search for hotels based on hotel features.
static class	HotelSearchCriterion.HotelMeetingFacility Used to search for hotels based on meeting facility requirements.
static class	HotelSearchCriterion.Media Used to search for hotels based on available media content.
static class	HotelSearchCriterion.RateRange Requested rate or rate range.
static class	HotelSearchCriterion.Recreation Identifies recreation facilities or amenities of interest.
static class	HotelSearchCriterion.RoomStayCandidates Collection of room stay candidates.
static class	HotelSearchCriterion.Service Identifies services of interest.
static class	HotelSearchCriterion.Transportation Identifies transportation facilities.

Nested classes/interfaces inherited from class org.ota.shared.ItemSearchCriterion

ItemSearchCriterion.Address, ItemSearchCriterion.CodeRef, ItemSearchCriterion.HotelRef, ItemSearchCriterion.Importance, ItemSearchCriterion.MapArea, ItemSearchCriterion.Radius, ItemSearchCriterion.RefPoint

Constructor Summary

HotelSearchCriterion()

Method Summary

void	addAward(HotelSearchCriterion.Award item) Add a 'Award' element item.
void	addHotelAmenity(HotelSearchCriterion.HotelAmenity item) Add a 'HotelAmenity' element item.
void	addHotelFeature(HotelSearchCriterion.HotelFeature item) Add a 'HotelFeature' element item.
void	addMedia(HotelSearchCriterion.Media item) Add a 'Media' element item.
void	addRateRange(HotelSearchCriterion.RateRange item) Add a 'RateRange' element item.
void	addRecreation(HotelSearchCriterion.Recreation item) Add a 'Recreation' element item.
void	addRoomAmenity(RoomAmenityPref item) Add a 'RoomAmenity' element item.
void	addService(HotelSearchCriterion.Service item) Add a 'Service' element item.
void	addTransportation(HotelSearchCriterion.Transportation item) Add a 'Transportation' element item.
void	clearAwards() Remove all 'Award' element items.
void	clearHotelAmenities() Remove all 'HotelAmenity' element items.
void	clearHotelFeatures() Remove all 'HotelFeature' element items.
void	clearMedias() Remove all 'Media' element items.
void	clearRateRanges() Remove all 'RateRange' element items.
void	clearRecreations() Remove all 'Recreation' element items.
void	clearRoomAmenities() Remove all 'RoomAmenity' element items.
void	clearServices() Remove all 'Service' element items.
void	clearTransportations() Remove all 'Transportation' element items.
AcceptedPayments	getAcceptedPayments() Get the 'AcceptedPayments' element value.
HotelSearchCriterion.Award	getAward(int index) Get 'Award' element item by position.
java.util.List<HotelSearchCriterion.Award>	getAwards() Get the list of 'Award' element items.
java.util.List<HotelSearchCriterion.HotelAmenity>	getHotelAmenities() Get the list of 'HotelAmenity' element items.
HotelSearchCriterion.HotelAmenity	getHotelAmenity(int index) Get 'HotelAmenity' element item by position.
HotelSearchCriterion.HotelFeature	getHotelFeature(int index) Get 'HotelFeature' element item by position.
java.util.List<HotelSearchCriterion.HotelFeature>	getHotelFeatures() Get the list of 'HotelFeature' element items.
HotelSearchCriterion.HotelMeetingFacility	getHotelMeetingFacility() Get the 'HotelMeetingFacility' element value.
HotelSearchCriterion.Media	getMedia(int index) Get 'Media' element item by position.
java.util.List<HotelSearchCriterion.Media>	getMedias() Get the list of 'Media' element items.
Profiles	getProfiles() Get the 'Profiles' element value.
RatePlanCandidates	getRatePlanCandidates() Get the 'RatePlanCandidates' element value.
HotelSearchCriterion.RateRange	getRateRange(int index) Get 'RateRange' element item by position.
java.util.List<HotelSearchCriterion.RateRange>	getRateRanges() Get the list of 'RateRange' element items.
HotelSearchCriterion.Recreation	getRecreation(int index) Get 'Recreation' element item by position.
java.util.List<HotelSearchCriterion.Recreation>	getRecreations() Get the list of 'Recreation' element items.
java.util.List<RoomAmenityPref>	getRoomAmenities() Get the list of 'RoomAmenity' element items.
RoomAmenityPref	getRoomAmenity(int index) Get 'RoomAmenity' element item by position.
HotelSearchCriterion.RoomStayCandidates	getRoomStayCandidates() Get the 'RoomStayCandidates' element value.
HotelSearchCriterion.Service	getService(int index) Get 'Service' element item by position.
java.util.List<HotelSearchCriterion.Service>	getServices() Get the list of 'Service' element items.
DateTimeSpan	getStayDateRange() Get the 'StayDateRange' element value.
TPAExtensions	getTPAExtensions() Get the 'TPA_Extensions' element value.
HotelSearchCriterion.Transportation	getTransportation(int index) Get 'Transportation' element item by position.
java.util.List<HotelSearchCriterion.Transportation>	getTransportations() Get the list of 'Transportation' element items.
void	setAcceptedPayments(AcceptedPayments acceptedPayments) Set the 'AcceptedPayments' element value.
void	setAwards(java.util.List<HotelSearchCriterion.Award> list) Set the list of 'Award' element items.
void	setHotelAmenities(java.util.List<HotelSearchCriterion.HotelAmenity> list) Set the list of 'HotelAmenity' element items.
void	setHotelFeatures(java.util.List<HotelSearchCriterion.HotelFeature> list) Set the list of 'HotelFeature' element items.
void	setHotelMeetingFacility(HotelSearchCriterion.HotelMeetingFacility hotelMeetingFacility) Set the 'HotelMeetingFacility' element value.
void	setMedias(java.util.List<HotelSearchCriterion.Media> list) Set the list of 'Media' element items.
void	setProfiles(Profiles profiles) Set the 'Profiles' element value.
void	setRatePlanCandidates(RatePlanCandidates ratePlanCandidates) Set the 'RatePlanCandidates' element value.
void	setRateRanges(java.util.List<HotelSearchCriterion.RateRange> list) Set the list of 'RateRange' element items.
void	setRecreations(java.util.List<HotelSearchCriterion.Recreation> list) Set the list of 'Recreation' element items.
void	setRoomAmenities(java.util.List<RoomAmenityPref> list) Set the list of 'RoomAmenity' element items.
void	setRoomStayCandidates(HotelSearchCriterion.RoomStayCandidates roomStayCandidates) Set the 'RoomStayCandidates' element value.
void	setServices(java.util.List<HotelSearchCriterion.Service> list) Set the list of 'Service' element items.
void	setStayDateRange(DateTimeSpan stayDateRange) Set the 'StayDateRange' element value.
void	setTPAExtensions(TPAExtensions TPAExtensions) Set the 'TPA_Extensions' element value.
void	setTransportations(java.util.List<HotelSearchCriterion.Transportation> list) Set the list of 'Transportation' element items.
int	sizeAwards() Get the number of 'Award' element items.
int	sizeHotelAmenities() Get the number of 'HotelAmenity' element items.
int	sizeHotelFeatures() Get the number of 'HotelFeature' element items.
int	sizeMedias() Get the number of 'Media' element items.
int	sizeRateRanges() Get the number of 'RateRange' element items.
int	sizeRecreations() Get the number of 'Recreation' element items.
int	sizeRoomAmenities() Get the number of 'RoomAmenity' element items.
int	sizeServices() Get the number of 'Service' element items.
int	sizeTransportations() Get the number of 'Transportation' element items.

Methods inherited from class org.ota.shared.ItemSearchCriterion

addHotelRef, addRefPoint, clearHotelRefs, clearRefPoints, getAddress, getCodeRef, getExactMatch, getHotelRef, getHotelRefs, getImportance, getMapArea, getPosition, getRadius, getRanking, getRefPoint, getRefPoints, getTelephone, setAddress, setCodeRef, setExactMatch, setHotelRefs, setImportance, setMapArea, setPosition, setRadius, setRanking, setRefPoints, setTelephone, sizeHotelRefs, sizeRefPoints

Methods inherited from class java.lang.Object

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

Constructor Detail

HotelSearchCriterion

public HotelSearchCriterion()

Method Detail

getHotelAmenities

public java.util.List<HotelSearchCriterion.HotelAmenity> getHotelAmenities()

Get the list of 'HotelAmenity' element items.

Returns:

list

setHotelAmenities

public void setHotelAmenities(java.util.List<HotelSearchCriterion.HotelAmenity> list)

Set the list of 'HotelAmenity' element items.

Parameters:

list -

sizeHotelAmenities

public int sizeHotelAmenities()

Get the number of 'HotelAmenity' element items.

Returns:

count

addHotelAmenity

public void addHotelAmenity(HotelSearchCriterion.HotelAmenity item)

Add a 'HotelAmenity' element item.

Parameters:

item -

getHotelAmenity

public HotelSearchCriterion.HotelAmenity getHotelAmenity(int index)

Get 'HotelAmenity' element item by position.

Parameters:

index -

Returns:

item

clearHotelAmenities

public void clearHotelAmenities()

Remove all 'HotelAmenity' element items.

getRoomAmenities

public java.util.List<RoomAmenityPref> getRoomAmenities()

Get the list of 'RoomAmenity' element items. Room level amenities for searches.

Returns:

list

setRoomAmenities

public void setRoomAmenities(java.util.List<RoomAmenityPref> list)

Set the list of 'RoomAmenity' element items. Room level amenities for searches.

Parameters:

list -

sizeRoomAmenities

public int sizeRoomAmenities()

Get the number of 'RoomAmenity' element items.

Returns:

count

addRoomAmenity

public void addRoomAmenity(RoomAmenityPref item)

Add a 'RoomAmenity' element item.

Parameters:

item -

getRoomAmenity

public RoomAmenityPref getRoomAmenity(int index)

Get 'RoomAmenity' element item by position.

Parameters:

index -

Returns:

item

clearRoomAmenities

public void clearRoomAmenities()

Remove all 'RoomAmenity' element items.

getHotelFeatures

public java.util.List<HotelSearchCriterion.HotelFeature> getHotelFeatures()

Get the list of 'HotelFeature' element items.

Returns:

list

setHotelFeatures

public void setHotelFeatures(java.util.List<HotelSearchCriterion.HotelFeature> list)

Set the list of 'HotelFeature' element items.

Parameters:

list -

sizeHotelFeatures

public int sizeHotelFeatures()

Get the number of 'HotelFeature' element items.

Returns:

count

addHotelFeature

public void addHotelFeature(HotelSearchCriterion.HotelFeature item)

Add a 'HotelFeature' element item.

Parameters:

item -

getHotelFeature

public HotelSearchCriterion.HotelFeature getHotelFeature(int index)

Get 'HotelFeature' element item by position.

Parameters:

index -

Returns:

item

clearHotelFeatures

public void clearHotelFeatures()

Remove all 'HotelFeature' element items.

getAwards

public java.util.List<HotelSearchCriterion.Award> getAwards()

Get the list of 'Award' element items.

Returns:

list

setAwards

public void setAwards(java.util.List<HotelSearchCriterion.Award> list)

Set the list of 'Award' element items.

Parameters:

list -

sizeAwards

public int sizeAwards()

Get the number of 'Award' element items.

Returns:

count

addAward

public void addAward(HotelSearchCriterion.Award item)

Add a 'Award' element item.

Parameters:

item -

getAward

public HotelSearchCriterion.Award getAward(int index)

Get 'Award' element item by position.

Parameters:

index -

Returns:

item

clearAwards

public void clearAwards()

Remove all 'Award' element items.

getRecreations

public java.util.List<HotelSearchCriterion.Recreation> getRecreations()

Get the list of 'Recreation' element items.

Returns:

list

setRecreations

public void setRecreations(java.util.List<HotelSearchCriterion.Recreation> list)

Set the list of 'Recreation' element items.

Parameters:

list -

sizeRecreations

public int sizeRecreations()

Get the number of 'Recreation' element items.

Returns:

count

addRecreation

public void addRecreation(HotelSearchCriterion.Recreation item)

Add a 'Recreation' element item.

Parameters:

item -

getRecreation

public HotelSearchCriterion.Recreation getRecreation(int index)

Get 'Recreation' element item by position.

Parameters:

index -

Returns:

item

clearRecreations

public void clearRecreations()

Remove all 'Recreation' element items.

getServices

public java.util.List<HotelSearchCriterion.Service> getServices()

Get the list of 'Service' element items.

Returns:

list

setServices

public void setServices(java.util.List<HotelSearchCriterion.Service> list)

Set the list of 'Service' element items.

Parameters:

list -

sizeServices

public int sizeServices()

Get the number of 'Service' element items.

Returns:

count

addService

public void addService(HotelSearchCriterion.Service item)

Add a 'Service' element item.

Parameters:

item -

getService

public HotelSearchCriterion.Service getService(int index)

Get 'Service' element item by position.

Parameters:

index -

Returns:

item

clearServices

public void clearServices()

Remove all 'Service' element items.

getTransportations

public java.util.List<HotelSearchCriterion.Transportation> getTransportations()

Get the list of 'Transportation' element items.

Returns:

list

setTransportations

public void setTransportations(java.util.List<HotelSearchCriterion.Transportation> list)

Set the list of 'Transportation' element items.

Parameters:

list -

sizeTransportations

public int sizeTransportations()

Get the number of 'Transportation' element items.

Returns:

count

addTransportation

public void addTransportation(HotelSearchCriterion.Transportation item)

Add a 'Transportation' element item.

Parameters:

item -

getTransportation

public HotelSearchCriterion.Transportation getTransportation(int index)

Get 'Transportation' element item by position.

Parameters:

index -

Returns:

item

clearTransportations

public void clearTransportations()

Remove all 'Transportation' element items.

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).

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).

Parameters:

stayDateRange -

getRateRanges

public java.util.List<HotelSearchCriterion.RateRange> getRateRanges()

Get the list of 'RateRange' element items.

Returns:

list

setRateRanges

public void setRateRanges(java.util.List<HotelSearchCriterion.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(HotelSearchCriterion.RateRange item)

Add a 'RateRange' element item.

Parameters:

item -

getRateRange

public HotelSearchCriterion.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. 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 -

getProfiles

public Profiles getProfiles()

Get the 'Profiles' element value. A collection of profile objects or unique IDs of profiles.

Returns:

value

setProfiles

public void setProfiles(Profiles profiles)

Set the 'Profiles' element value. A collection of profile objects or unique IDs of profiles.

Parameters:

profiles -

getRoomStayCandidates

public HotelSearchCriterion.RoomStayCandidates getRoomStayCandidates()

Get the 'RoomStayCandidates' element value.

Returns:

value

setRoomStayCandidates

public void setRoomStayCandidates(HotelSearchCriterion.RoomStayCandidates roomStayCandidates)

Set the 'RoomStayCandidates' element value.

Parameters:

roomStayCandidates -

getAcceptedPayments

public AcceptedPayments getAcceptedPayments()

Get the 'AcceptedPayments' element value. Provides the ability to search for hotel(s) based on whether they accept specific form(s) of payment.

Returns:

value

setAcceptedPayments

public void setAcceptedPayments(AcceptedPayments acceptedPayments)

Set the 'AcceptedPayments' element value. Provides the ability to search for hotel(s) based on whether they accept specific form(s) of payment.

Parameters:

acceptedPayments -

getMedias

public java.util.List<HotelSearchCriterion.Media> getMedias()

Get the list of 'Media' element items.

Returns:

list

setMedias

public void setMedias(java.util.List<HotelSearchCriterion.Media> list)

Set the list of 'Media' element items.

Parameters:

list -

sizeMedias

public int sizeMedias()

Get the number of 'Media' element items.

Returns:

count

addMedia

public void addMedia(HotelSearchCriterion.Media item)

Add a 'Media' element item.

Parameters:

item -

getMedia

public HotelSearchCriterion.Media getMedia(int index)

Get 'Media' element item by position.

Parameters:

index -

Returns:

item

clearMedias

public void clearMedias()

Remove all 'Media' element items.

getHotelMeetingFacility

public HotelSearchCriterion.HotelMeetingFacility getHotelMeetingFacility()

Get the 'HotelMeetingFacility' element value.

Returns:

value

setHotelMeetingFacility

public void setHotelMeetingFacility(HotelSearchCriterion.HotelMeetingFacility hotelMeetingFacility)

Set the 'HotelMeetingFacility' element value.

Parameters:

hotelMeetingFacility -

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 -