org.ota.vehicle
Class RateRuleRQ

java.lang.Object
  org.ota.vehicle.RateRuleRQ

public class RateRuleRQ
extends java.lang.Object

The OTA_VehRateRuleRQ will allow additional details to be requested regarding a previously quoted rate or a reservation that is already confirmed. 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="OTA_VehRateRuleRQ">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:POS_Type" name="POS"/>
       <xs:choice>
         <xs:element type="ns:UniqueID_Type" name="Reference"/>
         <xs:element name="RentalInfo">
           <xs:complexType>
             <xs:sequence>
               <xs:element type="ns:VehicleRentalCoreType" name="VehRentalCore"/>
               <xs:element type="ns:VehiclePrefType" name="VehicleInfo"/>
               <xs:element name="SpecialEquipPrefs" minOccurs="0">
                 <!-- Reference to inner class SpecialEquipPrefs -->
               </xs:element>
               <xs:element name="CustLoyalty" minOccurs="0" maxOccurs="4">
                 <xs:complexType>
                   <xs:attributeGroup ref="ns:CustomerLoyaltyGroup"/>
                 </xs:complexType>
               </xs:element>
               <xs:element name="RateQualifier" minOccurs="0">
                 <!-- Reference to inner class RateQualifier -->
               </xs:element>
               <xs:element type="ns:OffLocationServiceType" name="OffLocService" minOccurs="0"/>
               <xs:element type="ns:VehicleArrivalDetailsType" name="ArrivalDetails" minOccurs="0"/>
               <xs:element type="ns:VehicleTourInfoType" name="TourInfo" minOccurs="0"/>
               <xs:element type="ns:UniqueID_Type" name="CustomerID" minOccurs="0"/>
               <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
             </xs:sequence>
             <xs:attribute type="ns:InventoryStatusType" use="optional" name="Status"/>
           </xs:complexType>
         </xs:element>
       </xs:choice>
     </xs:sequence>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
     <xs:attributeGroup ref="ns:CompanyID_AttributesGroup"/>
     <xs:attributeGroup ref="ns:ReqRespVersion"/>
   </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"/>
 
 <xs:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ReqRespVersion">
   <xs:attribute type="xs:string" use="optional" name="ReqRespVersion"/>
 </xs:attributeGroup>
 

Nested Class Summary

static class	RateRuleRQ.RateQualifier Indicates the type of rates of interest to the customer, along with any discount number or promotional codes that may affect the rate.
static class	RateRuleRQ.SpecialEquipPrefs Indicates the preferences for one or more specific items of additional equipment, such as ski racks, child seats, etc.

Constructor Summary

RateRuleRQ()

Method Summary

void	addRentalInfoCustLoyalty(CustomerLoyaltyGroup item) Add a 'CustLoyalty' element item.
void	clearChoiceSelect() Clear the choice selection.
void	clearRentalInfoCustLoyalties() Remove all 'CustLoyalty' element items.
CompanyIDAttributesGroup	getCompanyIDAttributesGroup() Get the 'CompanyID_AttributesGroup' attributeGroup value.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
POS	getPOS() Get the 'POS' element value.
RateRuleRQ.RateQualifier	getRateQualifier() Get the 'RateQualifier' element value.
UniqueID	getReference() Get the 'Reference' element value.
VehicleArrivalDetails	getRentalInfoArrivalDetails() Get the 'ArrivalDetails' element value.
java.util.List<CustomerLoyaltyGroup>	getRentalInfoCustLoyalties() Get the list of 'CustLoyalty' element items.
CustomerLoyaltyGroup	getRentalInfoCustLoyalty(int index) Get 'CustLoyalty' element item by position.
UniqueID	getRentalInfoCustomerID() Get the 'CustomerID' element value.
OffLocationService	getRentalInfoOffLocService() Get the 'OffLocService' element value.
InventoryStatus	getRentalInfoStatus() Get the 'Status' attribute value.
VehicleTourInfo	getRentalInfoTourInfo() Get the 'TourInfo' element value.
TPAExtensions	getRentalInfoTPAExtensions() Get the 'TPA_Extensions' element value.
VehiclePref	getRentalInfoVehicleInfo() Get the 'VehicleInfo' element value.
VehicleRentalCore	getRentalInfoVehRentalCore() Get the 'VehRentalCore' element value.
java.lang.String	getReqRespVersion() Get the 'ReqRespVersion' attribute value.
RateRuleRQ.SpecialEquipPrefs	getSpecialEquipPrefs() Get the 'SpecialEquipPrefs' element value.
boolean	ifReference() Check if Reference is current selection for choice.
boolean	ifRentalInfo() Check if RentalInfo is current selection for choice.
void	setCompanyIDAttributesGroup(CompanyIDAttributesGroup companyIDAttributesGroup) Set the 'CompanyID_AttributesGroup' attributeGroup value.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setPOS(POS POS) Set the 'POS' element value.
void	setRateQualifier(RateRuleRQ.RateQualifier rateQualifier) Set the 'RateQualifier' element value.
void	setReference(UniqueID reference) Set the 'Reference' element value.
void	setRentalInfoArrivalDetails(VehicleArrivalDetails rentalInfoArrivalDetails) Set the 'ArrivalDetails' element value.
void	setRentalInfoCustLoyalties(java.util.List<CustomerLoyaltyGroup> list) Set the list of 'CustLoyalty' element items.
void	setRentalInfoCustomerID(UniqueID rentalInfoCustomerID) Set the 'CustomerID' element value.
void	setRentalInfoOffLocService(OffLocationService rentalInfoOffLocService) Set the 'OffLocService' element value.
void	setRentalInfoStatus(InventoryStatus rentalInfoStatus) Set the 'Status' attribute value.
void	setRentalInfoTourInfo(VehicleTourInfo rentalInfoTourInfo) Set the 'TourInfo' element value.
void	setRentalInfoTPAExtensions(TPAExtensions rentalInfoTPAExtensions) Set the 'TPA_Extensions' element value.
void	setRentalInfoVehicleInfo(VehiclePref rentalInfoVehicleInfo) Set the 'VehicleInfo' element value.
void	setRentalInfoVehRentalCore(VehicleRentalCore rentalInfoVehRentalCore) Set the 'VehRentalCore' element value.
void	setReqRespVersion(java.lang.String reqRespVersion) Set the 'ReqRespVersion' attribute value.
void	setSpecialEquipPrefs(RateRuleRQ.SpecialEquipPrefs specialEquipPrefs) Set the 'SpecialEquipPrefs' element value.
int	sizeRentalInfoCustLoyalties() Get the number of 'CustLoyalty' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

RateRuleRQ

public RateRuleRQ()

Method Detail

getPOS

public POS getPOS()

Get the 'POS' element value. Point of Sale Identification. Identification number of the vendor that has made the vehicle rate rule request and agency number assigned by IATA, ARC, ESRP or TID.

Returns:

value

setPOS

public void setPOS(POS POS)

Set the 'POS' element value. Point of Sale Identification. Identification number of the vendor that has made the vehicle rate rule request and agency number assigned by IATA, ARC, ESRP or TID.

Parameters:

POS -

clearChoiceSelect

public void clearChoiceSelect()

Clear the choice selection.

ifReference

public boolean ifReference()

Check if Reference is current selection for choice.

Returns:

true if selection, false if not

getReference

public UniqueID getReference()

Get the 'Reference' element value. The reference element will be used to send either the confirmation number when retrieving rate rule information for a previously confirmed booking or a reference ID from a previous rate display.

Returns:

value

setReference

public void setReference(UniqueID reference)

Set the 'Reference' element value. The reference element will be used to send either the confirmation number when retrieving rate rule information for a previously confirmed booking or a reference ID from a previous rate display.

Parameters:

reference -

ifRentalInfo

public boolean ifRentalInfo()

Check if RentalInfo is current selection for choice.

Returns:

true if selection, false if not

getRentalInfoVehRentalCore

public VehicleRentalCore getRentalInfoVehRentalCore()

Get the 'VehRentalCore' element value. Information that is common, or core, to all requests and responses associated with the reservation of a vehicle.

Returns:

value

setRentalInfoVehRentalCore

public void setRentalInfoVehRentalCore(VehicleRentalCore rentalInfoVehRentalCore)

Set the 'VehRentalCore' element value. Information that is common, or core, to all requests and responses associated with the reservation of a vehicle.

Parameters:

rentalInfoVehRentalCore -

getRentalInfoVehicleInfo

public VehiclePref getRentalInfoVehicleInfo()

Get the 'VehicleInfo' element value. A preference for one specific vehicle type.

Returns:

value

setRentalInfoVehicleInfo

public void setRentalInfoVehicleInfo(VehiclePref rentalInfoVehicleInfo)

Set the 'VehicleInfo' element value. A preference for one specific vehicle type.

Parameters:

rentalInfoVehicleInfo -

getSpecialEquipPrefs

public RateRuleRQ.SpecialEquipPrefs getSpecialEquipPrefs()

Get the 'SpecialEquipPrefs' element value. Contains information for a vehicle rental.

Returns:

value

setSpecialEquipPrefs

public void setSpecialEquipPrefs(RateRuleRQ.SpecialEquipPrefs specialEquipPrefs)

Set the 'SpecialEquipPrefs' element value. Contains information for a vehicle rental.

Parameters:

specialEquipPrefs -

getRentalInfoCustLoyalties

public java.util.List<CustomerLoyaltyGroup> getRentalInfoCustLoyalties()

Get the list of 'CustLoyalty' element items. Used to send frequent renter membership information.

Returns:

list

setRentalInfoCustLoyalties

public void setRentalInfoCustLoyalties(java.util.List<CustomerLoyaltyGroup> list)

Set the list of 'CustLoyalty' element items. Used to send frequent renter membership information.

Parameters:

list -

sizeRentalInfoCustLoyalties

public int sizeRentalInfoCustLoyalties()

Get the number of 'CustLoyalty' element items.

Returns:

count

addRentalInfoCustLoyalty

public void addRentalInfoCustLoyalty(CustomerLoyaltyGroup item)

Add a 'CustLoyalty' element item.

Parameters:

item -

getRentalInfoCustLoyalty

public CustomerLoyaltyGroup getRentalInfoCustLoyalty(int index)

Get 'CustLoyalty' element item by position.

Parameters:

index -

Returns:

item

clearRentalInfoCustLoyalties

public void clearRentalInfoCustLoyalties()

Remove all 'CustLoyalty' element items.

getRateQualifier

public RateRuleRQ.RateQualifier getRateQualifier()

Get the 'RateQualifier' element value. Contains information for a vehicle rental.

Returns:

value

setRateQualifier

public void setRateQualifier(RateRuleRQ.RateQualifier rateQualifier)

Set the 'RateQualifier' element value. Contains information for a vehicle rental.

Parameters:

rateQualifier -

getRentalInfoOffLocService

public OffLocationService getRentalInfoOffLocService()

Get the 'OffLocService' element value. Information on requested off-airport location services, for example, vehicle delivery, customer pickup.

Returns:

value

setRentalInfoOffLocService

public void setRentalInfoOffLocService(OffLocationService rentalInfoOffLocService)

Set the 'OffLocService' element value. Information on requested off-airport location services, for example, vehicle delivery, customer pickup.

Parameters:

rentalInfoOffLocService -

getRentalInfoArrivalDetails

public VehicleArrivalDetails getRentalInfoArrivalDetails()

Get the 'ArrivalDetails' element value. Details of the arrival transportation, if applicable

Returns:

value

setRentalInfoArrivalDetails

public void setRentalInfoArrivalDetails(VehicleArrivalDetails rentalInfoArrivalDetails)

Set the 'ArrivalDetails' element value. Details of the arrival transportation, if applicable

Parameters:

rentalInfoArrivalDetails -

getRentalInfoTourInfo

public VehicleTourInfo getRentalInfoTourInfo()

Get the 'TourInfo' element value. Tour information for which rate rules are requested.

Returns:

value

setRentalInfoTourInfo

public void setRentalInfoTourInfo(VehicleTourInfo rentalInfoTourInfo)

Set the 'TourInfo' element value. Tour information for which rate rules are requested.

Parameters:

rentalInfoTourInfo -

getRentalInfoCustomerID

public UniqueID getRentalInfoCustomerID()

Get the 'CustomerID' element value. The identification of the customer for whom the rate rule is being requested. This is different from the customer loyalty number.

Returns:

value

setRentalInfoCustomerID

public void setRentalInfoCustomerID(UniqueID rentalInfoCustomerID)

Set the 'CustomerID' element value. The identification of the customer for whom the rate rule is being requested. This is different from the customer loyalty number.

Parameters:

rentalInfoCustomerID -

getRentalInfoTPAExtensions

public TPAExtensions getRentalInfoTPAExtensions()

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

setRentalInfoTPAExtensions

public void setRentalInfoTPAExtensions(TPAExtensions rentalInfoTPAExtensions)

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:

rentalInfoTPAExtensions -

getRentalInfoStatus

public InventoryStatus getRentalInfoStatus()

Get the 'Status' attribute value. Indicates the status of the rate.

Returns:

value

setRentalInfoStatus

public void setRentalInfoStatus(InventoryStatus rentalInfoStatus)

Set the 'Status' attribute value. Indicates the status of the rate.

Parameters:

rentalInfoStatus -

getOTAPayloadStdAttributes

public OTAPayloadStdAttributes getOTAPayloadStdAttributes()

Get the 'OTA_PayloadStdAttributes' attributeGroup value.

Returns:

value

setOTAPayloadStdAttributes

public void setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes)

Set the 'OTA_PayloadStdAttributes' attributeGroup value.

Parameters:

OTAPayloadStdAttributes -

getCompanyIDAttributesGroup

public CompanyIDAttributesGroup getCompanyIDAttributesGroup()

Get the 'CompanyID_AttributesGroup' attributeGroup value. Identity of the car supplier for which the rate rules are being requested.

Returns:

value

setCompanyIDAttributesGroup

public void setCompanyIDAttributesGroup(CompanyIDAttributesGroup companyIDAttributesGroup)

Set the 'CompanyID_AttributesGroup' attributeGroup value. Identity of the car supplier for which the rate rules are being requested.

Parameters:

companyIDAttributesGroup -

getReqRespVersion

public java.lang.String getReqRespVersion()

Get the 'ReqRespVersion' attribute value. Used to request the version of the payload message desired for the response.

Returns:

value

setReqRespVersion

public void setReqRespVersion(java.lang.String reqRespVersion)

Set the 'ReqRespVersion' attribute value. Used to request the version of the payload message desired for the response.

Parameters:

reqRespVersion -