org.ota.air
Class AirSearchPrefs

java.lang.Object
  org.ota.air.AirSearchPrefs

Direct Known Subclasses:

FareDisplayRQ.TravelPreferences, LowFareSearchRQ.TravelPreferences

public class AirSearchPrefs
extends java.lang.Object

Defines user preferences to be used in conducting 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="AirSearchPrefsType">
   <xs:sequence>
     <xs:element name="VendorPref" minOccurs="0" maxOccurs="99">
       <!-- Reference to inner class VendorPref -->
     </xs:element>
     <xs:element name="FlightTypePref" minOccurs="0" maxOccurs="3">
       <xs:complexType>
         <xs:attributeGroup ref="ns:FlightTypePrefGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element name="FareRestrictPref" minOccurs="0" maxOccurs="4">
       <!-- Reference to inner class FareRestrictPref -->
     </xs:element>
     <xs:element type="ns:EquipmentTypePref" name="EquipPref" minOccurs="0" maxOccurs="9"/>
     <xs:element name="CabinPref" minOccurs="0" maxOccurs="3">
       <!-- Reference to inner class CabinPref -->
     </xs:element>
     <xs:element name="TicketDistribPref" minOccurs="0" maxOccurs="3">
       <!-- Reference to inner class TicketDistribPref -->
     </xs:element>
   </xs:sequence>
   <xs:attributeGroup ref="ns:SmokingIndicatorGroup"/>
   <xs:attribute type="xs:float" use="optional" name="OnTimeRate"/>
   <xs:attribute type="xs:boolean" use="optional" name="ETicketDesired"/>
   <xs:attribute type="xs:int" use="optional" name="MaxStopsQuantity"/>
   <xs:attributeGroup ref="ns:DateTimeSpanGroup"/>
 </xs:complexType>
 
 <xs:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="SmokingIndicatorGroup">
   <xs:attribute type="xs:boolean" use="optional" name="SmokingAllowed"/>
 </xs:attributeGroup>
 

Nested Class Summary

static class	AirSearchPrefs.CabinPref Defines preferred cabin(s) to be used in a search.
static class	AirSearchPrefs.FareRestrictPref Constrains a fare search to those with restrictions that satisfy user-imposed limitations.
static class	AirSearchPrefs.TicketDistribPref Defines Distribution prefernces.
static class	AirSearchPrefs.VendorPref Specify vendors to include and exclude from the response.

Constructor Summary

AirSearchPrefs()

Method Summary

void	addCabinPref(AirSearchPrefs.CabinPref item) Add a 'CabinPref' element item.
void	addEquipPref(EquipmentTypePref item) Add a 'EquipPref' element item.
void	addFareRestrictPref(AirSearchPrefs.FareRestrictPref item) Add a 'FareRestrictPref' element item.
void	addFlightTypePref(FlightTypePrefGroup item) Add a 'FlightTypePref' element item.
void	addTicketDistribPref(AirSearchPrefs.TicketDistribPref item) Add a 'TicketDistribPref' element item.
void	addVendorPref(AirSearchPrefs.VendorPref item) Add a 'VendorPref' element item.
void	clearCabinPrefs() Remove all 'CabinPref' element items.
void	clearEquipPrefs() Remove all 'EquipPref' element items.
void	clearFareRestrictPrefs() Remove all 'FareRestrictPref' element items.
void	clearFlightTypePrefs() Remove all 'FlightTypePref' element items.
void	clearTicketDistribPrefs() Remove all 'TicketDistribPref' element items.
void	clearVendorPrefs() Remove all 'VendorPref' element items.
AirSearchPrefs.CabinPref	getCabinPref(int index) Get 'CabinPref' element item by position.
java.util.List<AirSearchPrefs.CabinPref>	getCabinPrefs() Get the list of 'CabinPref' element items.
DateTimeSpanGroup	getDateTimeSpanGroup() Get the 'DateTimeSpanGroup' attributeGroup value.
EquipmentTypePref	getEquipPref(int index) Get 'EquipPref' element item by position.
java.util.List<EquipmentTypePref>	getEquipPrefs() Get the list of 'EquipPref' element items.
java.lang.Boolean	getETicketDesired() Get the 'ETicketDesired' attribute value.
AirSearchPrefs.FareRestrictPref	getFareRestrictPref(int index) Get 'FareRestrictPref' element item by position.
java.util.List<AirSearchPrefs.FareRestrictPref>	getFareRestrictPrefs() Get the list of 'FareRestrictPref' element items.
FlightTypePrefGroup	getFlightTypePref(int index) Get 'FlightTypePref' element item by position.
java.util.List<FlightTypePrefGroup>	getFlightTypePrefs() Get the list of 'FlightTypePref' element items.
java.lang.Integer	getMaxStopsQuantity() Get the 'MaxStopsQuantity' attribute value.
java.lang.Float	getOnTimeRate() Get the 'OnTimeRate' attribute value.
java.lang.Boolean	getSmokingAllowed() Get the 'SmokingAllowed' attribute value.
AirSearchPrefs.TicketDistribPref	getTicketDistribPref(int index) Get 'TicketDistribPref' element item by position.
java.util.List<AirSearchPrefs.TicketDistribPref>	getTicketDistribPrefs() Get the list of 'TicketDistribPref' element items.
AirSearchPrefs.VendorPref	getVendorPref(int index) Get 'VendorPref' element item by position.
java.util.List<AirSearchPrefs.VendorPref>	getVendorPrefs() Get the list of 'VendorPref' element items.
void	setCabinPrefs(java.util.List<AirSearchPrefs.CabinPref> list) Set the list of 'CabinPref' element items.
void	setDateTimeSpanGroup(DateTimeSpanGroup dateTimeSpanGroup) Set the 'DateTimeSpanGroup' attributeGroup value.
void	setEquipPrefs(java.util.List<EquipmentTypePref> list) Set the list of 'EquipPref' element items.
void	setETicketDesired(java.lang.Boolean ETicketDesired) Set the 'ETicketDesired' attribute value.
void	setFareRestrictPrefs(java.util.List<AirSearchPrefs.FareRestrictPref> list) Set the list of 'FareRestrictPref' element items.
void	setFlightTypePrefs(java.util.List<FlightTypePrefGroup> list) Set the list of 'FlightTypePref' element items.
void	setMaxStopsQuantity(java.lang.Integer maxStopsQuantity) Set the 'MaxStopsQuantity' attribute value.
void	setOnTimeRate(java.lang.Float onTimeRate) Set the 'OnTimeRate' attribute value.
void	setSmokingAllowed(java.lang.Boolean smokingAllowed) Set the 'SmokingAllowed' attribute value.
void	setTicketDistribPrefs(java.util.List<AirSearchPrefs.TicketDistribPref> list) Set the list of 'TicketDistribPref' element items.
void	setVendorPrefs(java.util.List<AirSearchPrefs.VendorPref> list) Set the list of 'VendorPref' element items.
int	sizeCabinPrefs() Get the number of 'CabinPref' element items.
int	sizeEquipPrefs() Get the number of 'EquipPref' element items.
int	sizeFareRestrictPrefs() Get the number of 'FareRestrictPref' element items.
int	sizeFlightTypePrefs() Get the number of 'FlightTypePref' element items.
int	sizeTicketDistribPrefs() Get the number of 'TicketDistribPref' element items.
int	sizeVendorPrefs() Get the number of 'VendorPref' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

AirSearchPrefs

public AirSearchPrefs()

Method Detail

getVendorPrefs

public java.util.List<AirSearchPrefs.VendorPref> getVendorPrefs()

Get the list of 'VendorPref' element items.

Returns:

list

setVendorPrefs

public void setVendorPrefs(java.util.List<AirSearchPrefs.VendorPref> list)

Set the list of 'VendorPref' element items.

Parameters:

list -

sizeVendorPrefs

public int sizeVendorPrefs()

Get the number of 'VendorPref' element items.

Returns:

count

addVendorPref

public void addVendorPref(AirSearchPrefs.VendorPref item)

Add a 'VendorPref' element item.

Parameters:

item -

getVendorPref

public AirSearchPrefs.VendorPref getVendorPref(int index)

Get 'VendorPref' element item by position.

Parameters:

index -

Returns:

item

clearVendorPrefs

public void clearVendorPrefs()

Remove all 'VendorPref' element items.

getFlightTypePrefs

public java.util.List<FlightTypePrefGroup> getFlightTypePrefs()

Get the list of 'FlightTypePref' element items. Defines preferred flight characteristics to be used in a search.

Returns:

list

setFlightTypePrefs

public void setFlightTypePrefs(java.util.List<FlightTypePrefGroup> list)

Set the list of 'FlightTypePref' element items. Defines preferred flight characteristics to be used in a search.

Parameters:

list -

sizeFlightTypePrefs

public int sizeFlightTypePrefs()

Get the number of 'FlightTypePref' element items.

Returns:

count

addFlightTypePref

public void addFlightTypePref(FlightTypePrefGroup item)

Add a 'FlightTypePref' element item.

Parameters:

item -

getFlightTypePref

public FlightTypePrefGroup getFlightTypePref(int index)

Get 'FlightTypePref' element item by position.

Parameters:

index -

Returns:

item

clearFlightTypePrefs

public void clearFlightTypePrefs()

Remove all 'FlightTypePref' element items.

getFareRestrictPrefs

public java.util.List<AirSearchPrefs.FareRestrictPref> getFareRestrictPrefs()

Get the list of 'FareRestrictPref' element items.

Returns:

list

setFareRestrictPrefs

public void setFareRestrictPrefs(java.util.List<AirSearchPrefs.FareRestrictPref> list)

Set the list of 'FareRestrictPref' element items.

Parameters:

list -

sizeFareRestrictPrefs

public int sizeFareRestrictPrefs()

Get the number of 'FareRestrictPref' element items.

Returns:

count

addFareRestrictPref

public void addFareRestrictPref(AirSearchPrefs.FareRestrictPref item)

Add a 'FareRestrictPref' element item.

Parameters:

item -

getFareRestrictPref

public AirSearchPrefs.FareRestrictPref getFareRestrictPref(int index)

Get 'FareRestrictPref' element item by position.

Parameters:

index -

Returns:

item

clearFareRestrictPrefs

public void clearFareRestrictPrefs()

Remove all 'FareRestrictPref' element items.

getEquipPrefs

public java.util.List<EquipmentTypePref> getEquipPrefs()

Get the list of 'EquipPref' element items. Defines preferred equipment profile(s) to be used in a search.

Returns:

list

setEquipPrefs

public void setEquipPrefs(java.util.List<EquipmentTypePref> list)

Set the list of 'EquipPref' element items. Defines preferred equipment profile(s) to be used in a search.

Parameters:

list -

sizeEquipPrefs

public int sizeEquipPrefs()

Get the number of 'EquipPref' element items.

Returns:

count

addEquipPref

public void addEquipPref(EquipmentTypePref item)

Add a 'EquipPref' element item.

Parameters:

item -

getEquipPref

public EquipmentTypePref getEquipPref(int index)

Get 'EquipPref' element item by position.

Parameters:

index -

Returns:

item

clearEquipPrefs

public void clearEquipPrefs()

Remove all 'EquipPref' element items.

getCabinPrefs

public java.util.List<AirSearchPrefs.CabinPref> getCabinPrefs()

Get the list of 'CabinPref' element items.

Returns:

list

setCabinPrefs

public void setCabinPrefs(java.util.List<AirSearchPrefs.CabinPref> list)

Set the list of 'CabinPref' element items.

Parameters:

list -

sizeCabinPrefs

public int sizeCabinPrefs()

Get the number of 'CabinPref' element items.

Returns:

count

addCabinPref

public void addCabinPref(AirSearchPrefs.CabinPref item)

Add a 'CabinPref' element item.

Parameters:

item -

getCabinPref

public AirSearchPrefs.CabinPref getCabinPref(int index)

Get 'CabinPref' element item by position.

Parameters:

index -

Returns:

item

clearCabinPrefs

public void clearCabinPrefs()

Remove all 'CabinPref' element items.

getTicketDistribPrefs

public java.util.List<AirSearchPrefs.TicketDistribPref> getTicketDistribPrefs()

Get the list of 'TicketDistribPref' element items.

Returns:

list

setTicketDistribPrefs

public void setTicketDistribPrefs(java.util.List<AirSearchPrefs.TicketDistribPref> list)

Set the list of 'TicketDistribPref' element items.

Parameters:

list -

sizeTicketDistribPrefs

public int sizeTicketDistribPrefs()

Get the number of 'TicketDistribPref' element items.

Returns:

count

addTicketDistribPref

public void addTicketDistribPref(AirSearchPrefs.TicketDistribPref item)

Add a 'TicketDistribPref' element item.

Parameters:

item -

getTicketDistribPref

public AirSearchPrefs.TicketDistribPref getTicketDistribPref(int index)

Get 'TicketDistribPref' element item by position.

Parameters:

index -

Returns:

item

clearTicketDistribPrefs

public void clearTicketDistribPrefs()

Remove all 'TicketDistribPref' element items.

getSmokingAllowed

public java.lang.Boolean getSmokingAllowed()

Get the 'SmokingAllowed' attribute value. Indicates smoking is allowed when true and is not allowed when false. false

Returns:

value

setSmokingAllowed

public void setSmokingAllowed(java.lang.Boolean smokingAllowed)

Set the 'SmokingAllowed' attribute value. Indicates smoking is allowed when true and is not allowed when false. false

Parameters:

smokingAllowed -

getOnTimeRate

public java.lang.Float getOnTimeRate()

Get the 'OnTimeRate' attribute value. Request for flights in response that meet the given Department of Transport on-time rate. This is a number between 0 and 100.

Returns:

value

setOnTimeRate

public void setOnTimeRate(java.lang.Float onTimeRate)

Set the 'OnTimeRate' attribute value. Request for flights in response that meet the given Department of Transport on-time rate. This is a number between 0 and 100.

Parameters:

onTimeRate -

getETicketDesired

public java.lang.Boolean getETicketDesired()

Get the 'ETicketDesired' attribute value. Request flights that are e-ticketable in the response. false

Returns:

value

setETicketDesired

public void setETicketDesired(java.lang.Boolean ETicketDesired)

Set the 'ETicketDesired' attribute value. Request flights that are e-ticketable in the response. false

Parameters:

ETicketDesired -

getMaxStopsQuantity

public java.lang.Integer getMaxStopsQuantity()

Get the 'MaxStopsQuantity' attribute value. Request flights that have no more than the requested number of stops.

Returns:

value

setMaxStopsQuantity

public void setMaxStopsQuantity(java.lang.Integer maxStopsQuantity)

Set the 'MaxStopsQuantity' attribute value. Request flights that have no more than the requested number of stops.

Parameters:

maxStopsQuantity -

getDateTimeSpanGroup

public DateTimeSpanGroup getDateTimeSpanGroup()

Get the 'DateTimeSpanGroup' attributeGroup value. Used to specify the earliest and latest departure times for which flights are requested.

Returns:

value

setDateTimeSpanGroup

public void setDateTimeSpanGroup(DateTimeSpanGroup dateTimeSpanGroup)

Set the 'DateTimeSpanGroup' attributeGroup value. Used to specify the earliest and latest departure times for which flights are requested.

Parameters:

dateTimeSpanGroup -