org.ota.shared
Class ItemSearchCriterion

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

Direct Known Subclasses:

HotelSearchCriterion

public class ItemSearchCriterion
extends java.lang.Object

Identifies the criterion for a search. 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="ItemSearchCriterionType">
   <xs:sequence>
     <xs:element name="Position" minOccurs="0">
       <xs:complexType>
         <xs:attributeGroup ref="ns:PositionGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element name="Address" minOccurs="0">
       <!-- Reference to inner class Address -->
     </xs:element>
     <xs:element name="Telephone" minOccurs="0">
       <xs:complexType>
         <xs:attributeGroup ref="ns:TelephoneGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element name="RefPoint" minOccurs="0" maxOccurs="999">
       <!-- Reference to inner class RefPoint -->
     </xs:element>
     <xs:element name="CodeRef" minOccurs="0">
       <!-- Reference to inner class CodeRef -->
     </xs:element>
     <xs:element name="HotelRef" minOccurs="0" maxOccurs="99">
       <!-- Reference to inner class HotelRef -->
     </xs:element>
     <xs:element name="Radius" minOccurs="0">
       <!-- Reference to inner class Radius -->
     </xs:element>
     <xs:element name="MapArea" minOccurs="0">
       <!-- Reference to inner class MapArea -->
     </xs:element>
   </xs:sequence>
   <xs:attribute type="xs:boolean" use="optional" name="ExactMatch"/>
   <xs:attribute use="optional" name="ImportanceType">
     <xs:simpleType>
       <!-- Reference to inner class Importance -->
     </xs:simpleType>
   </xs:attribute>
   <xs:attribute type="xs:int" use="optional" name="Ranking"/>
 </xs:complexType>
 

Nested Class Summary

static class	ItemSearchCriterion.Address Uses any part of address information, such as street name, postal code, or country code.
static class	ItemSearchCriterion.CodeRef Indicates the location of points of interest.
static class	ItemSearchCriterion.HotelRef Indicates the detail of hotel reference information.
static class	ItemSearchCriterion.Importance Schema fragment(s) for this class:
static class	ItemSearchCriterion.MapArea Provides coordinates used to define the area of a map.
static class	ItemSearchCriterion.Radius Used to specify the extent of a search area.
static class	ItemSearchCriterion.RefPoint The Reference Point element allows for a search by proximity to a designated reference point by name.

Constructor Summary

ItemSearchCriterion()

Method Summary

void	addHotelRef(ItemSearchCriterion.HotelRef item) Add a 'HotelRef' element item.
void	addRefPoint(ItemSearchCriterion.RefPoint item) Add a 'RefPoint' element item.
void	clearHotelRefs() Remove all 'HotelRef' element items.
void	clearRefPoints() Remove all 'RefPoint' element items.
ItemSearchCriterion.Address	getAddress() Get the 'Address' element value.
ItemSearchCriterion.CodeRef	getCodeRef() Get the 'CodeRef' element value.
java.lang.Boolean	getExactMatch() Get the 'ExactMatch' attribute value.
ItemSearchCriterion.HotelRef	getHotelRef(int index) Get 'HotelRef' element item by position.
java.util.List<ItemSearchCriterion.HotelRef>	getHotelRefs() Get the list of 'HotelRef' element items.
ItemSearchCriterion.Importance	getImportance() Get the 'ImportanceType' attribute value.
ItemSearchCriterion.MapArea	getMapArea() Get the 'MapArea' element value.
PositionGroup	getPosition() Get the 'PositionGroup' attributeGroup value.
ItemSearchCriterion.Radius	getRadius() Get the 'Radius' element value.
java.lang.Integer	getRanking() Get the 'Ranking' attribute value.
ItemSearchCriterion.RefPoint	getRefPoint(int index) Get 'RefPoint' element item by position.
java.util.List<ItemSearchCriterion.RefPoint>	getRefPoints() Get the list of 'RefPoint' element items.
TelephoneGroup	getTelephone() Get the 'TelephoneGroup' attributeGroup value.
void	setAddress(ItemSearchCriterion.Address address) Set the 'Address' element value.
void	setCodeRef(ItemSearchCriterion.CodeRef codeRef) Set the 'CodeRef' element value.
void	setExactMatch(java.lang.Boolean exactMatch) Set the 'ExactMatch' attribute value.
void	setHotelRefs(java.util.List<ItemSearchCriterion.HotelRef> list) Set the list of 'HotelRef' element items.
void	setImportance(ItemSearchCriterion.Importance importance) Set the 'ImportanceType' attribute value.
void	setMapArea(ItemSearchCriterion.MapArea mapArea) Set the 'MapArea' element value.
void	setPosition(PositionGroup position) Set the 'PositionGroup' attributeGroup value.
void	setRadius(ItemSearchCriterion.Radius radius) Set the 'Radius' element value.
void	setRanking(java.lang.Integer ranking) Set the 'Ranking' attribute value.
void	setRefPoints(java.util.List<ItemSearchCriterion.RefPoint> list) Set the list of 'RefPoint' element items.
void	setTelephone(TelephoneGroup telephone) Set the 'TelephoneGroup' attributeGroup value.
int	sizeHotelRefs() Get the number of 'HotelRef' element items.
int	sizeRefPoints() Get the number of 'RefPoint' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemSearchCriterion

public ItemSearchCriterion()

Method Detail

getPosition

public PositionGroup getPosition()

Get the 'PositionGroup' attributeGroup value. The geographic coordinates for the search.

Returns:

value

setPosition

public void setPosition(PositionGroup position)

Set the 'PositionGroup' attributeGroup value. The geographic coordinates for the search.

Parameters:

position -

getAddress

public ItemSearchCriterion.Address getAddress()

Get the 'Address' element value.

Returns:

value

setAddress

public void setAddress(ItemSearchCriterion.Address address)

Set the 'Address' element value.

Parameters:

address -

getTelephone

public TelephoneGroup getTelephone()

Get the 'TelephoneGroup' attributeGroup value. Detailed telephone information for the search.

Returns:

value

setTelephone

public void setTelephone(TelephoneGroup telephone)

Set the 'TelephoneGroup' attributeGroup value. Detailed telephone information for the search.

Parameters:

telephone -

getRefPoints

public java.util.List<ItemSearchCriterion.RefPoint> getRefPoints()

Get the list of 'RefPoint' element items.

Returns:

list

setRefPoints

public void setRefPoints(java.util.List<ItemSearchCriterion.RefPoint> list)

Set the list of 'RefPoint' element items.

Parameters:

list -

sizeRefPoints

public int sizeRefPoints()

Get the number of 'RefPoint' element items.

Returns:

count

addRefPoint

public void addRefPoint(ItemSearchCriterion.RefPoint item)

Add a 'RefPoint' element item.

Parameters:

item -

getRefPoint

public ItemSearchCriterion.RefPoint getRefPoint(int index)

Get 'RefPoint' element item by position.

Parameters:

index -

Returns:

item

clearRefPoints

public void clearRefPoints()

Remove all 'RefPoint' element items.

getCodeRef

public ItemSearchCriterion.CodeRef getCodeRef()

Get the 'CodeRef' element value.

Returns:

value

setCodeRef

public void setCodeRef(ItemSearchCriterion.CodeRef codeRef)

Set the 'CodeRef' element value.

Parameters:

codeRef -

getHotelRefs

public java.util.List<ItemSearchCriterion.HotelRef> getHotelRefs()

Get the list of 'HotelRef' element items.

Returns:

list

setHotelRefs

public void setHotelRefs(java.util.List<ItemSearchCriterion.HotelRef> list)

Set the list of 'HotelRef' element items.

Parameters:

list -

sizeHotelRefs

public int sizeHotelRefs()

Get the number of 'HotelRef' element items.

Returns:

count

addHotelRef

public void addHotelRef(ItemSearchCriterion.HotelRef item)

Add a 'HotelRef' element item.

Parameters:

item -

getHotelRef

public ItemSearchCriterion.HotelRef getHotelRef(int index)

Get 'HotelRef' element item by position.

Parameters:

index -

Returns:

item

clearHotelRefs

public void clearHotelRefs()

Remove all 'HotelRef' element items.

getRadius

public ItemSearchCriterion.Radius getRadius()

Get the 'Radius' element value.

Returns:

value

setRadius

public void setRadius(ItemSearchCriterion.Radius radius)

Set the 'Radius' element value.

Parameters:

radius -

getMapArea

public ItemSearchCriterion.MapArea getMapArea()

Get the 'MapArea' element value.

Returns:

value

setMapArea

public void setMapArea(ItemSearchCriterion.MapArea mapArea)

Set the 'MapArea' element value.

Parameters:

mapArea -

getExactMatch

public java.lang.Boolean getExactMatch()

Get the 'ExactMatch' attribute value. Values of "true" or "false", indicating whether the string of the search value must be an exact match.

Returns:

value

setExactMatch

public void setExactMatch(java.lang.Boolean exactMatch)

Set the 'ExactMatch' attribute value. Values of "true" or "false", indicating whether the string of the search value must be an exact match.

Parameters:

exactMatch -

getImportance

public ItemSearchCriterion.Importance getImportance()

Get the 'ImportanceType' attribute value. An enumerated list, indicating the level of importance of the search criterion. Acceptable values are "Mandatory", "High", "Medium", or "Low."

Returns:

value

setImportance

public void setImportance(ItemSearchCriterion.Importance importance)

Set the 'ImportanceType' attribute value. An enumerated list, indicating the level of importance of the search criterion. Acceptable values are "Mandatory", "High", "Medium", or "Low."

Parameters:

importance -

getRanking

public java.lang.Integer getRanking()

Get the 'Ranking' attribute value. Defines a ranking scale expressed as integers; meaning and scale are based on individual implementations.

Returns:

value

setRanking

public void setRanking(java.lang.Integer ranking)

Set the 'Ranking' attribute value. Defines a ranking scale expressed as integers; meaning and scale are based on individual implementations.

Parameters:

ranking -