org.ota.vehicle
Class CheckOutRQ

java.lang.Object
  org.ota.vehicle.CheckOutRQ

public class CheckOutRQ
extends java.lang.Object

This message will allow a rental customer to engage in a car rental agreement allowing the customer to take possession of a specific vehicle. 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_VehCheckOutRQ">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:POS_Type" name="POS"/>
       <xs:element type="ns:CustomerPrimaryAdditionalType" name="Customer" minOccurs="0"/>
       <xs:element name="DriverType" minOccurs="0" maxOccurs="3">
         <xs:complexType>
           <xs:attributeGroup ref="ns:TravelerCountGroup"/>
         </xs:complexType>
       </xs:element>
       <xs:element type="ns:VehicleRentalCoreType" name="PickUpReturnDetails" minOccurs="0"/>
       <xs:element type="ns:CompanyNamePrefType" name="VendorPref" minOccurs="0"/>
       <xs:element type="ns:VehiclePrefType" name="VehPref" minOccurs="0"/>
       <xs:element name="VehMakeModel" minOccurs="0">
         <xs:complexType>
           <xs:attributeGroup ref="ns:VehicleMakeModelGroup"/>
         </xs:complexType>
       </xs:element>
       <xs:element name="VehIdentity" minOccurs="0">
         <xs:complexType>
           <xs:attributeGroup ref="ns:VehicleIdentityGroup"/>
         </xs:complexType>
       </xs:element>
       <xs:element type="ns:VehicleRentalDetailsType" name="VehDetailsOut" minOccurs="0"/>
       <xs:element name="RateQualifier" minOccurs="0">
         <xs:complexType>
           <xs:attributeGroup ref="ns:RateQualifierCoreGroup"/>
         </xs:complexType>
       </xs:element>
       <xs:element type="ns:VehicleRentalRateType" name="RentalRate" minOccurs="0"/>
       <xs:element type="ns:CoveragePricedType" name="PricedCoverage" minOccurs="0"/>
       <xs:element name="SpecialEquipPrefs" minOccurs="0">
         <!-- Reference to inner class SpecialEquipPrefs -->
       </xs:element>
       <xs:element type="ns:VehicleChargePurposeType" name="Fee" minOccurs="0"/>
       <xs:element type="ns:UniqueID_Type" name="ConfID" minOccurs="0"/>
       <xs:element type="ns:UniqueID_Type" name="ContractID" minOccurs="0"/>
       <xs:element type="ns:PaymentDetailType" name="RentalPaymentAmount" minOccurs="0" maxOccurs="5"/>
       <xs:element name="Remarks" minOccurs="0">
         <!-- Reference to inner class Remarks -->
       </xs:element>
       <xs:element type="ns:VehicleReservationRQAdditionalInfoType" name="VehRentalAdditionalInfo" minOccurs="0"/>
     </xs:sequence>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
     <xs:attributeGroup ref="ns:RentalActionGroup"/>
     <xs:attributeGroup ref="ns:ReqRespVersion"/>
   </xs:complexType>
 </xs:element>
 
 <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	CheckOutRQ.Remarks A collection of remarks.
static class	CheckOutRQ.SpecialEquipPrefs Collection of special equipment preferences.

Constructor Summary

CheckOutRQ()

Method Summary

void	addDriver(TravelerCountGroup item) Add a 'DriverType' element item.
void	addRentalPaymentAmount(PaymentDetail item) Add a 'RentalPaymentAmount' element item.
void	clearDrivers() Remove all 'DriverType' element items.
void	clearRentalPaymentAmounts() Remove all 'RentalPaymentAmount' element items.
UniqueID	getConfID() Get the 'ConfID' element value.
UniqueID	getContractID() Get the 'ContractID' element value.
CustomerPrimaryAdditional	getCustomer() Get the 'Customer' element value.
TravelerCountGroup	getDriver(int index) Get 'DriverType' element item by position.
java.util.List<TravelerCountGroup>	getDrivers() Get the list of 'DriverType' element items.
VehicleChargePurpose	getFee() Get the 'Fee' element value.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
VehicleRentalCore	getPickUpReturnDetails() Get the 'PickUpReturnDetails' element value.
POS	getPOS() Get the 'POS' element value.
CoveragePriced	getPricedCoverage() Get the 'PricedCoverage' element value.
RateQualifierCoreGroup	getRateQualifier() Get the 'RateQualifierCoreGroup' attributeGroup value.
CheckOutRQ.Remarks	getRemarks() Get the 'Remarks' element value.
RentalActionGroup	getRentalActionGroup() Get the 'RentalActionGroup' attributeGroup value.
PaymentDetail	getRentalPaymentAmount(int index) Get 'RentalPaymentAmount' element item by position.
java.util.List<PaymentDetail>	getRentalPaymentAmounts() Get the list of 'RentalPaymentAmount' element items.
VehicleRentalRate	getRentalRate() Get the 'RentalRate' element value.
java.lang.String	getReqRespVersion() Get the 'ReqRespVersion' attribute value.
CheckOutRQ.SpecialEquipPrefs	getSpecialEquipPrefs() Get the 'SpecialEquipPrefs' element value.
VehicleRentalDetails	getVehDetailsOut() Get the 'VehDetailsOut' element value.
VehicleIdentityGroup	getVehIdentity() Get the 'VehicleIdentityGroup' attributeGroup value.
VehicleMakeModelGroup	getVehMakeModel() Get the 'VehicleMakeModelGroup' attributeGroup value.
VehiclePref	getVehPref() Get the 'VehPref' element value.
VehicleReservationRQAdditionalInfo	getVehRentalAdditionalInfo() Get the 'VehRentalAdditionalInfo' element value.
CompanyNamePref	getVendorPref() Get the 'VendorPref' element value.
void	setConfID(UniqueID confID) Set the 'ConfID' element value.
void	setContractID(UniqueID contractID) Set the 'ContractID' element value.
void	setCustomer(CustomerPrimaryAdditional customer) Set the 'Customer' element value.
void	setDrivers(java.util.List<TravelerCountGroup> list) Set the list of 'DriverType' element items.
void	setFee(VehicleChargePurpose fee) Set the 'Fee' element value.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setPickUpReturnDetails(VehicleRentalCore pickUpReturnDetails) Set the 'PickUpReturnDetails' element value.
void	setPOS(POS POS) Set the 'POS' element value.
void	setPricedCoverage(CoveragePriced pricedCoverage) Set the 'PricedCoverage' element value.
void	setRateQualifier(RateQualifierCoreGroup rateQualifier) Set the 'RateQualifierCoreGroup' attributeGroup value.
void	setRemarks(CheckOutRQ.Remarks remarks) Set the 'Remarks' element value.
void	setRentalActionGroup(RentalActionGroup rentalActionGroup) Set the 'RentalActionGroup' attributeGroup value.
void	setRentalPaymentAmounts(java.util.List<PaymentDetail> list) Set the list of 'RentalPaymentAmount' element items.
void	setRentalRate(VehicleRentalRate rentalRate) Set the 'RentalRate' element value.
void	setReqRespVersion(java.lang.String reqRespVersion) Set the 'ReqRespVersion' attribute value.
void	setSpecialEquipPrefs(CheckOutRQ.SpecialEquipPrefs specialEquipPrefs) Set the 'SpecialEquipPrefs' element value.
void	setVehDetailsOut(VehicleRentalDetails vehDetailsOut) Set the 'VehDetailsOut' element value.
void	setVehIdentity(VehicleIdentityGroup vehIdentity) Set the 'VehicleIdentityGroup' attributeGroup value.
void	setVehMakeModel(VehicleMakeModelGroup vehMakeModel) Set the 'VehicleMakeModelGroup' attributeGroup value.
void	setVehPref(VehiclePref vehPref) Set the 'VehPref' element value.
void	setVehRentalAdditionalInfo(VehicleReservationRQAdditionalInfo vehRentalAdditionalInfo) Set the 'VehRentalAdditionalInfo' element value.
void	setVendorPref(CompanyNamePref vendorPref) Set the 'VendorPref' element value.
int	sizeDrivers() Get the number of 'DriverType' element items.
int	sizeRentalPaymentAmounts() Get the number of 'RentalPaymentAmount' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckOutRQ

public CheckOutRQ()

Method Detail

getPOS

public POS getPOS()

Get the 'POS' element value. Describes the source of the transaction such as kiosk id or counter agent id.

Returns:

value

setPOS

public void setPOS(POS POS)

Set the 'POS' element value. Describes the source of the transaction such as kiosk id or counter agent id.

Parameters:

POS -

getCustomer

public CustomerPrimaryAdditional getCustomer()

Get the 'Customer' element value. This is the rental customer's information.

Returns:

value

setCustomer

public void setCustomer(CustomerPrimaryAdditional customer)

Set the 'Customer' element value. This is the rental customer's information.

Parameters:

customer -

getDrivers

public java.util.List<TravelerCountGroup> getDrivers()

Get the list of 'DriverType' element items. Indicates the number of people of each age category associated with this request.

Returns:

list

setDrivers

public void setDrivers(java.util.List<TravelerCountGroup> list)

Set the list of 'DriverType' element items. Indicates the number of people of each age category associated with this request.

Parameters:

list -

sizeDrivers

public int sizeDrivers()

Get the number of 'DriverType' element items.

Returns:

count

addDriver

public void addDriver(TravelerCountGroup item)

Add a 'DriverType' element item.

Parameters:

item -

getDriver

public TravelerCountGroup getDriver(int index)

Get 'DriverType' element item by position.

Parameters:

index -

Returns:

item

clearDrivers

public void clearDrivers()

Remove all 'DriverType' element items.

getPickUpReturnDetails

public VehicleRentalCore getPickUpReturnDetails()

Get the 'PickUpReturnDetails' element value. Typically this is used to provide the actual return date, time, and location.

Returns:

value

setPickUpReturnDetails

public void setPickUpReturnDetails(VehicleRentalCore pickUpReturnDetails)

Set the 'PickUpReturnDetails' element value. Typically this is used to provide the actual return date, time, and location.

Parameters:

pickUpReturnDetails -

getVendorPref

public CompanyNamePref getVendorPref()

Get the 'VendorPref' element value.

Returns:

value

setVendorPref

public void setVendorPref(CompanyNamePref vendorPref)

Set the 'VendorPref' element value.

Parameters:

vendorPref -

getVehPref

public VehiclePref getVehPref()

Get the 'VehPref' element value. Indicates any preferences for the vehicle, such as type, class, transmission, air conditioning.

Returns:

value

setVehPref

public void setVehPref(VehiclePref vehPref)

Set the 'VehPref' element value. Indicates any preferences for the vehicle, such as type, class, transmission, air conditioning.

Parameters:

vehPref -

getVehMakeModel

public VehicleMakeModelGroup getVehMakeModel()

Get the 'VehicleMakeModelGroup' attributeGroup value. The make and model of the vehicle (e.g., Ford Focus). The Code attribute may be used for the SIPP code.

Returns:

value

setVehMakeModel

public void setVehMakeModel(VehicleMakeModelGroup vehMakeModel)

Set the 'VehicleMakeModelGroup' attributeGroup value. The make and model of the vehicle (e.g., Ford Focus). The Code attribute may be used for the SIPP code.

Parameters:

vehMakeModel -

getVehIdentity

public VehicleIdentityGroup getVehIdentity()

Get the 'VehicleIdentityGroup' attributeGroup value. The specific identifiers of the vehicle (e.g., Motor Vehicle Asset Number).

Returns:

value

setVehIdentity

public void setVehIdentity(VehicleIdentityGroup vehIdentity)

Set the 'VehicleIdentityGroup' attributeGroup value. The specific identifiers of the vehicle (e.g., Motor Vehicle Asset Number).

Parameters:

vehIdentity -

getVehDetailsOut

public VehicleRentalDetails getVehDetailsOut()

Get the 'VehDetailsOut' element value. Details of the Vehicle that needs to be checked out for the customer who is renting the vehicle.

Returns:

value

setVehDetailsOut

public void setVehDetailsOut(VehicleRentalDetails vehDetailsOut)

Set the 'VehDetailsOut' element value. Details of the Vehicle that needs to be checked out for the customer who is renting the vehicle.

Parameters:

vehDetailsOut -

getRateQualifier

public RateQualifierCoreGroup getRateQualifier()

Get the 'RateQualifierCoreGroup' attributeGroup value. Indicates the type of rates of interest to the customer, along with any discount number or promotional codes that may affect the rate.

Returns:

value

setRateQualifier

public void setRateQualifier(RateQualifierCoreGroup rateQualifier)

Set the 'RateQualifierCoreGroup' attributeGroup value. Indicates the type of rates of interest to the customer, along with any discount number or promotional codes that may affect the rate.

Parameters:

rateQualifier -

getRentalRate

public VehicleRentalRate getRentalRate()

Get the 'RentalRate' element value. Information on the rates associated with this vehicle. Rate information can include the distance and the base rental cost, along with information on the various factors that may infuence this rate.

Returns:

value

setRentalRate

public void setRentalRate(VehicleRentalRate rentalRate)

Set the 'RentalRate' element value. Information on the rates associated with this vehicle. Rate information can include the distance and the base rental cost, along with information on the various factors that may infuence this rate.

Parameters:

rentalRate -

getPricedCoverage

public CoveragePriced getPricedCoverage()

Get the 'PricedCoverage' element value. This is used when a requestor wishes to override the published price. If the price is not known or will not be overriden, a CoveragePref is used.

Returns:

value

setPricedCoverage

public void setPricedCoverage(CoveragePriced pricedCoverage)

Set the 'PricedCoverage' element value. This is used when a requestor wishes to override the published price. If the price is not known or will not be overriden, a CoveragePref is used.

Parameters:

pricedCoverage -

getSpecialEquipPrefs

public CheckOutRQ.SpecialEquipPrefs getSpecialEquipPrefs()

Get the 'SpecialEquipPrefs' element value.

Returns:

value

setSpecialEquipPrefs

public void setSpecialEquipPrefs(CheckOutRQ.SpecialEquipPrefs specialEquipPrefs)

Set the 'SpecialEquipPrefs' element value.

Parameters:

specialEquipPrefs -

getFee

public VehicleChargePurpose getFee()

Get the 'Fee' element value. Defines information on a specific charge associated with the rental of a vehicle along with the purpose of the charge (e.g. pre-paid fuel). This does not include insurance (see priced coverages).

Returns:

value

setFee

public void setFee(VehicleChargePurpose fee)

Set the 'Fee' element value. Defines information on a specific charge associated with the rental of a vehicle along with the purpose of the charge (e.g. pre-paid fuel). This does not include insurance (see priced coverages).

Parameters:

fee -

getConfID

public UniqueID getConfID()

Get the 'ConfID' element value. A confirmation number by which this reservation can be uniquely identified.

Returns:

value

setConfID

public void setConfID(UniqueID confID)

Set the 'ConfID' element value. A confirmation number by which this reservation can be uniquely identified.

Parameters:

confID -

getContractID

public UniqueID getContractID()

Get the 'ContractID' element value. A contract number by which this rental can be uniquely identified.

Returns:

value

setContractID

public void setContractID(UniqueID contractID)

Set the 'ContractID' element value. A contract number by which this rental can be uniquely identified.

Parameters:

contractID -

getRentalPaymentAmounts

public java.util.List<PaymentDetail> getRentalPaymentAmounts()

Get the list of 'RentalPaymentAmount' element items. This element may reflect a charge or reserve to a form of payment.

Returns:

list

setRentalPaymentAmounts

public void setRentalPaymentAmounts(java.util.List<PaymentDetail> list)

Set the list of 'RentalPaymentAmount' element items. This element may reflect a charge or reserve to a form of payment.

Parameters:

list -

sizeRentalPaymentAmounts

public int sizeRentalPaymentAmounts()

Get the number of 'RentalPaymentAmount' element items.

Returns:

count

addRentalPaymentAmount

public void addRentalPaymentAmount(PaymentDetail item)

Add a 'RentalPaymentAmount' element item.

Parameters:

item -

getRentalPaymentAmount

public PaymentDetail getRentalPaymentAmount(int index)

Get 'RentalPaymentAmount' element item by position.

Parameters:

index -

Returns:

item

clearRentalPaymentAmounts

public void clearRentalPaymentAmounts()

Remove all 'RentalPaymentAmount' element items.

getRemarks

public CheckOutRQ.Remarks getRemarks()

Get the 'Remarks' element value.

Returns:

value

setRemarks

public void setRemarks(CheckOutRQ.Remarks remarks)

Set the 'Remarks' element value.

Parameters:

remarks -

getVehRentalAdditionalInfo

public VehicleReservationRQAdditionalInfo getVehRentalAdditionalInfo()

Get the 'VehRentalAdditionalInfo' element value. Identifies the supplemental information associated with the request for the checkout of a rental vehicle.

Returns:

value

setVehRentalAdditionalInfo

public void setVehRentalAdditionalInfo(VehicleReservationRQAdditionalInfo vehRentalAdditionalInfo)

Set the 'VehRentalAdditionalInfo' element value. Identifies the supplemental information associated with the request for the checkout of a rental vehicle.

Parameters:

vehRentalAdditionalInfo -

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 -

getRentalActionGroup

public RentalActionGroup getRentalActionGroup()

Get the 'RentalActionGroup' attributeGroup value. This provides information on why the message is being sent and in what status the rental agreement is. If this is an initial request, RentalAgreementStatusCode would typically be blank.

Returns:

value

setRentalActionGroup

public void setRentalActionGroup(RentalActionGroup rentalActionGroup)

Set the 'RentalActionGroup' attributeGroup value. This provides information on why the message is being sent and in what status the rental agreement is. If this is an initial request, RentalAgreementStatusCode would typically be blank.

Parameters:

rentalActionGroup -

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 -