org.ota.vehicle
Class VehicleProfileRentalPref

java.lang.Object
  org.ota.vehicle.VehicleProfileRentalPref

public class VehicleProfileRentalPref
extends java.lang.Object

Vehicle rental preferences can be specified for customers or companies to indicate their preferences for types of vehicles to be rented in specific travel situations. Companies may wish to specify certain class or types of cars that their employees are allowed to rent, or indicate special business needs for trucks for hauling goods, etc. Personal travelers may wish to indicate preferences for types of vehicles such as vans or SUVs for family vacations, or smaller, more sporty models when travelling alone. A customer may prefer to have a convertible or sun roof in a warm destination, but request a ski rack when vacationing in the wintertime. The VehicleProfileRentalPrefType complex type has elements for specific features on rental cars including vehicle type (major category such as car, truck, SUV) and vehicle class (more precise kind of vehicle), air conditioning, transmission, and special equipment. In addition, the specification captures preferences for vendors and loyalty programs, insurance coverage, forms of payment for rental cars, and other special requirements. 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="VehicleProfileRentalPrefType">
   <xs:sequence>
     <xs:element name="LoyaltyPref" minOccurs="0" maxOccurs="20">
       <xs:complexType>
         <xs:attributeGroup ref="ns:RPH_PrefGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element type="ns:CompanyNamePrefType" name="VendorPref" minOccurs="0" maxOccurs="20"/>
     <xs:element name="PaymentFormPref" minOccurs="0" maxOccurs="10">
       <xs:complexType>
         <xs:attributeGroup ref="ns:RPH_PrefGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element name="CoveragePref" minOccurs="0" maxOccurs="30">
       <xs:complexType>
         <xs:attributeGroup ref="ns:VehicleCoveragePrefGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element type="ns:VehicleSpecialReqPrefType" name="SpecialReqPref" minOccurs="0" maxOccurs="5"/>
     <xs:element type="ns:VehiclePrefType" name="VehTypePref" minOccurs="0" maxOccurs="10"/>
     <xs:element name="SpecialEquipPref" minOccurs="0" maxOccurs="15">
       <xs:complexType>
         <xs:attributeGroup ref="ns:VehicleEquipmentPrefGroup"/>
       </xs:complexType>
     </xs:element>
   </xs:sequence>
   <xs:attributeGroup ref="ns:PreferLevelGroup"/>
   <xs:attributeGroup ref="ns:PrivacyGroup"/>
   <xs:attributeGroup ref="ns:SmokingIndicatorGroup"/>
   <xs:attribute type="xs:boolean" use="optional" name="GasPrePay"/>
 </xs:complexType>
 
 <xs:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="PreferLevelGroup">
   <xs:attribute type="ns:PreferLevelType" use="optional" name="PreferLevel"/>
 </xs:attributeGroup>
 
 <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>
 

Constructor Summary

VehicleProfileRentalPref()

Method Summary

void	addCoveragePref(VehicleCoveragePrefGroup item) Add a 'CoveragePref' element item.
void	addLoyaltyPref(RPHPrefGroup item) Add a 'LoyaltyPref' element item.
void	addPaymentFormPref(RPHPrefGroup item) Add a 'PaymentFormPref' element item.
void	addSpecialEquipPref(VehicleEquipmentPrefGroup item) Add a 'SpecialEquipPref' element item.
void	addSpecialReqPref(VehicleSpecialReqPref item) Add a 'SpecialReqPref' element item.
void	addVehTypePref(VehiclePref item) Add a 'VehTypePref' element item.
void	addVendorPref(CompanyNamePref item) Add a 'VendorPref' element item.
void	clearCoveragePrefs() Remove all 'CoveragePref' element items.
void	clearLoyaltyPrefs() Remove all 'LoyaltyPref' element items.
void	clearPaymentFormPrefs() Remove all 'PaymentFormPref' element items.
void	clearSpecialEquipPrefs() Remove all 'SpecialEquipPref' element items.
void	clearSpecialReqPrefs() Remove all 'SpecialReqPref' element items.
void	clearVehTypePrefs() Remove all 'VehTypePref' element items.
void	clearVendorPrefs() Remove all 'VendorPref' element items.
VehicleCoveragePrefGroup	getCoveragePref(int index) Get 'CoveragePref' element item by position.
java.util.List<VehicleCoveragePrefGroup>	getCoveragePrefs() Get the list of 'CoveragePref' element items.
java.lang.Boolean	getGasPrePay() Get the 'GasPrePay' attribute value.
RPHPrefGroup	getLoyaltyPref(int index) Get 'LoyaltyPref' element item by position.
java.util.List<RPHPrefGroup>	getLoyaltyPrefs() Get the list of 'LoyaltyPref' element items.
RPHPrefGroup	getPaymentFormPref(int index) Get 'PaymentFormPref' element item by position.
java.util.List<RPHPrefGroup>	getPaymentFormPrefs() Get the list of 'PaymentFormPref' element items.
PreferLevel	getPreferLevel() Get the 'PreferLevel' attribute value.
PrivacyGroup	getPrivacyGroup() Get the 'PrivacyGroup' attributeGroup value.
java.lang.Boolean	getSmokingAllowed() Get the 'SmokingAllowed' attribute value.
VehicleEquipmentPrefGroup	getSpecialEquipPref(int index) Get 'SpecialEquipPref' element item by position.
java.util.List<VehicleEquipmentPrefGroup>	getSpecialEquipPrefs() Get the list of 'SpecialEquipPref' element items.
VehicleSpecialReqPref	getSpecialReqPref(int index) Get 'SpecialReqPref' element item by position.
java.util.List<VehicleSpecialReqPref>	getSpecialReqPrefs() Get the list of 'SpecialReqPref' element items.
VehiclePref	getVehTypePref(int index) Get 'VehTypePref' element item by position.
java.util.List<VehiclePref>	getVehTypePrefs() Get the list of 'VehTypePref' element items.
CompanyNamePref	getVendorPref(int index) Get 'VendorPref' element item by position.
java.util.List<CompanyNamePref>	getVendorPrefs() Get the list of 'VendorPref' element items.
void	setCoveragePrefs(java.util.List<VehicleCoveragePrefGroup> list) Set the list of 'CoveragePref' element items.
void	setGasPrePay(java.lang.Boolean gasPrePay) Set the 'GasPrePay' attribute value.
void	setLoyaltyPrefs(java.util.List<RPHPrefGroup> list) Set the list of 'LoyaltyPref' element items.
void	setPaymentFormPrefs(java.util.List<RPHPrefGroup> list) Set the list of 'PaymentFormPref' element items.
void	setPreferLevel(PreferLevel preferLevel) Set the 'PreferLevel' attribute value.
void	setPrivacyGroup(PrivacyGroup privacyGroup) Set the 'PrivacyGroup' attributeGroup value.
void	setSmokingAllowed(java.lang.Boolean smokingAllowed) Set the 'SmokingAllowed' attribute value.
void	setSpecialEquipPrefs(java.util.List<VehicleEquipmentPrefGroup> list) Set the list of 'SpecialEquipPref' element items.
void	setSpecialReqPrefs(java.util.List<VehicleSpecialReqPref> list) Set the list of 'SpecialReqPref' element items.
void	setVehTypePrefs(java.util.List<VehiclePref> list) Set the list of 'VehTypePref' element items.
void	setVendorPrefs(java.util.List<CompanyNamePref> list) Set the list of 'VendorPref' element items.
int	sizeCoveragePrefs() Get the number of 'CoveragePref' element items.
int	sizeLoyaltyPrefs() Get the number of 'LoyaltyPref' element items.
int	sizePaymentFormPrefs() Get the number of 'PaymentFormPref' element items.
int	sizeSpecialEquipPrefs() Get the number of 'SpecialEquipPref' element items.
int	sizeSpecialReqPrefs() Get the number of 'SpecialReqPref' element items.
int	sizeVehTypePrefs() Get the number of 'VehTypePref' 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

VehicleProfileRentalPref

public VehicleProfileRentalPref()

Method Detail

getLoyaltyPrefs

public java.util.List<RPHPrefGroup> getLoyaltyPrefs()

Get the list of 'LoyaltyPref' element items. Indicates a preference for the loyalty program to be used for vehicle rental. The RPH (Reference Place Holder) attribute designates a specific loyalty program from a collection stored in the profile.

Returns:

list

setLoyaltyPrefs

public void setLoyaltyPrefs(java.util.List<RPHPrefGroup> list)

Set the list of 'LoyaltyPref' element items. Indicates a preference for the loyalty program to be used for vehicle rental. The RPH (Reference Place Holder) attribute designates a specific loyalty program from a collection stored in the profile.

Parameters:

list -

sizeLoyaltyPrefs

public int sizeLoyaltyPrefs()

Get the number of 'LoyaltyPref' element items.

Returns:

count

addLoyaltyPref

public void addLoyaltyPref(RPHPrefGroup item)

Add a 'LoyaltyPref' element item.

Parameters:

item -

getLoyaltyPref

public RPHPrefGroup getLoyaltyPref(int index)

Get 'LoyaltyPref' element item by position.

Parameters:

index -

Returns:

item

clearLoyaltyPrefs

public void clearLoyaltyPrefs()

Remove all 'LoyaltyPref' element items.

getVendorPrefs

public java.util.List<CompanyNamePref> getVendorPrefs()

Get the list of 'VendorPref' element items. Vendor Preferences indicates a preference for a specific car rental agency when used in a travel collection. The VendorPref element uses the Company Name entity to identify the preferred company by name and by vendor code.

Returns:

list

setVendorPrefs

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

Set the list of 'VendorPref' element items. Vendor Preferences indicates a preference for a specific car rental agency when used in a travel collection. The VendorPref element uses the Company Name entity to identify the preferred company by name and by vendor code.

Parameters:

list -

sizeVendorPrefs

public int sizeVendorPrefs()

Get the number of 'VendorPref' element items.

Returns:

count

addVendorPref

public void addVendorPref(CompanyNamePref item)

Add a 'VendorPref' element item.

Parameters:

item -

getVendorPref

public CompanyNamePref getVendorPref(int index)

Get 'VendorPref' element item by position.

Parameters:

index -

Returns:

item

clearVendorPrefs

public void clearVendorPrefs()

Remove all 'VendorPref' element items.

getPaymentFormPrefs

public java.util.List<RPHPrefGroup> getPaymentFormPrefs()

Get the list of 'PaymentFormPref' element items. A preference for a payment indicates a specific type of payment, such as a credit card or direct bill, to be assigned to the car rental preference collection. The RPH (Reference Place Holder) attribute designates a specific payment form in a collection stored in the profile.

Returns:

list

setPaymentFormPrefs

public void setPaymentFormPrefs(java.util.List<RPHPrefGroup> list)

Set the list of 'PaymentFormPref' element items. A preference for a payment indicates a specific type of payment, such as a credit card or direct bill, to be assigned to the car rental preference collection. The RPH (Reference Place Holder) attribute designates a specific payment form in a collection stored in the profile.

Parameters:

list -

sizePaymentFormPrefs

public int sizePaymentFormPrefs()

Get the number of 'PaymentFormPref' element items.

Returns:

count

addPaymentFormPref

public void addPaymentFormPref(RPHPrefGroup item)

Add a 'PaymentFormPref' element item.

Parameters:

item -

getPaymentFormPref

public RPHPrefGroup getPaymentFormPref(int index)

Get 'PaymentFormPref' element item by position.

Parameters:

index -

Returns:

item

clearPaymentFormPrefs

public void clearPaymentFormPrefs()

Remove all 'PaymentFormPref' element items.

getCoveragePrefs

public java.util.List<VehicleCoveragePrefGroup> getCoveragePrefs()

Get the list of 'CoveragePref' element items. A preference for a specific type of vehicle coverage to be used when renting a car in a given travel situation.

Returns:

list

setCoveragePrefs

public void setCoveragePrefs(java.util.List<VehicleCoveragePrefGroup> list)

Set the list of 'CoveragePref' element items. A preference for a specific type of vehicle coverage to be used when renting a car in a given travel situation.

Parameters:

list -

sizeCoveragePrefs

public int sizeCoveragePrefs()

Get the number of 'CoveragePref' element items.

Returns:

count

addCoveragePref

public void addCoveragePref(VehicleCoveragePrefGroup item)

Add a 'CoveragePref' element item.

Parameters:

item -

getCoveragePref

public VehicleCoveragePrefGroup getCoveragePref(int index)

Get 'CoveragePref' element item by position.

Parameters:

index -

Returns:

item

clearCoveragePrefs

public void clearCoveragePrefs()

Remove all 'CoveragePref' element items.

getSpecialReqPrefs

public java.util.List<VehicleSpecialReqPref> getSpecialReqPrefs()

Get the list of 'SpecialReqPref' element items. The special request preference element allows the customer to designate a special request to be associated with the vehicle rental.

Returns:

list

setSpecialReqPrefs

public void setSpecialReqPrefs(java.util.List<VehicleSpecialReqPref> list)

Set the list of 'SpecialReqPref' element items. The special request preference element allows the customer to designate a special request to be associated with the vehicle rental.

Parameters:

list -

sizeSpecialReqPrefs

public int sizeSpecialReqPrefs()

Get the number of 'SpecialReqPref' element items.

Returns:

count

addSpecialReqPref

public void addSpecialReqPref(VehicleSpecialReqPref item)

Add a 'SpecialReqPref' element item.

Parameters:

item -

getSpecialReqPref

public VehicleSpecialReqPref getSpecialReqPref(int index)

Get 'SpecialReqPref' element item by position.

Parameters:

index -

Returns:

item

clearSpecialReqPrefs

public void clearSpecialReqPrefs()

Remove all 'SpecialReqPref' element items.

getVehTypePrefs

public java.util.List<VehiclePref> getVehTypePrefs()

Get the list of 'VehTypePref' element items. The vehicle type preference element allows the customer to designate a major category of vehicle preferred for rental.

Returns:

list

setVehTypePrefs

public void setVehTypePrefs(java.util.List<VehiclePref> list)

Set the list of 'VehTypePref' element items. The vehicle type preference element allows the customer to designate a major category of vehicle preferred for rental.

Parameters:

list -

sizeVehTypePrefs

public int sizeVehTypePrefs()

Get the number of 'VehTypePref' element items.

Returns:

count

addVehTypePref

public void addVehTypePref(VehiclePref item)

Add a 'VehTypePref' element item.

Parameters:

item -

getVehTypePref

public VehiclePref getVehTypePref(int index)

Get 'VehTypePref' element item by position.

Parameters:

index -

Returns:

item

clearVehTypePrefs

public void clearVehTypePrefs()

Remove all 'VehTypePref' element items.

getSpecialEquipPrefs

public java.util.List<VehicleEquipmentPrefGroup> getSpecialEquipPrefs()

Get the list of 'SpecialEquipPref' element items. Indicates a preference for special equipment in a rented car.

Returns:

list

setSpecialEquipPrefs

public void setSpecialEquipPrefs(java.util.List<VehicleEquipmentPrefGroup> list)

Set the list of 'SpecialEquipPref' element items. Indicates a preference for special equipment in a rented car.

Parameters:

list -

sizeSpecialEquipPrefs

public int sizeSpecialEquipPrefs()

Get the number of 'SpecialEquipPref' element items.

Returns:

count

addSpecialEquipPref

public void addSpecialEquipPref(VehicleEquipmentPrefGroup item)

Add a 'SpecialEquipPref' element item.

Parameters:

item -

getSpecialEquipPref

public VehicleEquipmentPrefGroup getSpecialEquipPref(int index)

Get 'SpecialEquipPref' element item by position.

Parameters:

index -

Returns:

item

clearSpecialEquipPrefs

public void clearSpecialEquipPrefs()

Remove all 'SpecialEquipPref' element items.

getPreferLevel

public PreferLevel getPreferLevel()

Get the 'PreferLevel' attribute value. Used to indicate a level of preference for an associated item. Preferred

Returns:

value

setPreferLevel

public void setPreferLevel(PreferLevel preferLevel)

Set the 'PreferLevel' attribute value. Used to indicate a level of preference for an associated item. Preferred

Parameters:

preferLevel -

getPrivacyGroup

public PrivacyGroup getPrivacyGroup()

Get the 'PrivacyGroup' attributeGroup value.

Returns:

value

setPrivacyGroup

public void setPrivacyGroup(PrivacyGroup privacyGroup)

Set the 'PrivacyGroup' attributeGroup value.

Parameters:

privacyGroup -

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 -

getGasPrePay

public java.lang.Boolean getGasPrePay()

Get the 'GasPrePay' attribute value. The GasPrePay attribute defines a set of valid values for the choice of prepaying for gas at the time of the pick up of the rental vehicle. This information is useful in that it allows a customer's preference to be made known to the vendor. It also allows the vendor to provide more detailed and accurate pricing up front. false

Returns:

value

setGasPrePay

public void setGasPrePay(java.lang.Boolean gasPrePay)

Set the 'GasPrePay' attribute value. The GasPrePay attribute defines a set of valid values for the choice of prepaying for gas at the time of the pick up of the rental vehicle. This information is useful in that it allows a customer's preference to be made known to the vendor. It also allows the vendor to provide more detailed and accurate pricing up front. false

Parameters:

gasPrePay -