org.ota.vehicle
Class CheckInRQ

java.lang.Object
  org.ota.vehicle.CheckInRQ

public class CheckInRQ
extends java.lang.Object

This message is used to collect information about the vehicle and equipment being returned. 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_VehCheckInRQ">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:POS_Type" name="POS" 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:CustomerPrimaryAdditionalType" name="Customer" minOccurs="0"/>
       <xs:element type="ns:VehicleRentalCoreType" name="PickUpReturnDetails" minOccurs="0"/>
       <xs:element type="ns:PaymentDetailType" name="PaymentDetails" minOccurs="0" maxOccurs="5"/>
       <xs:element type="ns:VehicleType" name="Vehicle" minOccurs="0"/>
       <xs:element type="ns:VehicleRentalDetailsType" name="VehRentalDetails" minOccurs="0"/>
       <xs:element name="PricedEquips" minOccurs="0">
         <!-- Reference to inner class PricedEquips -->
       </xs:element>
       <xs:element name="AdjustmentDetails" minOccurs="0">
         <!-- Reference to inner class AdjustmentDetails -->
       </xs:element>
       <xs:element type="ns:OffLocationServiceCoreType" name="OffLocationServiceDetails" minOccurs="0"/>
       <xs:element name="Remarks" minOccurs="0">
         <!-- Reference to inner class Remarks -->
       </xs:element>
     </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	CheckInRQ.AdjustmentDetails Collection of adjustments.
static class	CheckInRQ.PricedEquips Collection of PricedEquip Schema fragment(s) for this class:
static class	CheckInRQ.Remarks A collection of remarks.

Constructor Summary

CheckInRQ()

Method Summary

void	addPaymentDetail(PaymentDetail item) Add a 'PaymentDetails' element item.
void	clearPaymentDetails() Remove all 'PaymentDetails' element items.
CheckInRQ.AdjustmentDetails	getAdjustmentDetails() Get the 'AdjustmentDetails' element value.
UniqueID	getConfID() Get the 'ConfID' element value.
UniqueID	getContractID() Get the 'ContractID' element value.
CustomerPrimaryAdditional	getCustomer() Get the 'Customer' element value.
OffLocationServiceCore	getOffLocationServiceDetails() Get the 'OffLocationServiceDetails' element value.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
PaymentDetail	getPaymentDetail(int index) Get 'PaymentDetails' element item by position.
java.util.List<PaymentDetail>	getPaymentDetails() Get the list of 'PaymentDetails' element items.
VehicleRentalCore	getPickUpReturnDetails() Get the 'PickUpReturnDetails' element value.
POS	getPOS() Get the 'POS' element value.
CheckInRQ.PricedEquips	getPricedEquips() Get the 'PricedEquips' element value.
CheckInRQ.Remarks	getRemarks() Get the 'Remarks' element value.
RentalActionGroup	getRentalActionGroup() Get the 'RentalActionGroup' attributeGroup value.
java.lang.String	getReqRespVersion() Get the 'ReqRespVersion' attribute value.
Vehicle	getVehicle() Get the 'Vehicle' element value.
VehicleRentalDetails	getVehRentalDetails() Get the 'VehRentalDetails' element value.
void	setAdjustmentDetails(CheckInRQ.AdjustmentDetails adjustmentDetails) Set the 'AdjustmentDetails' 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	setOffLocationServiceDetails(OffLocationServiceCore offLocationServiceDetails) Set the 'OffLocationServiceDetails' element value.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setPaymentDetails(java.util.List<PaymentDetail> list) Set the list of 'PaymentDetails' element items.
void	setPickUpReturnDetails(VehicleRentalCore pickUpReturnDetails) Set the 'PickUpReturnDetails' element value.
void	setPOS(POS POS) Set the 'POS' element value.
void	setPricedEquips(CheckInRQ.PricedEquips pricedEquips) Set the 'PricedEquips' element value.
void	setRemarks(CheckInRQ.Remarks remarks) Set the 'Remarks' element value.
void	setRentalActionGroup(RentalActionGroup rentalActionGroup) Set the 'RentalActionGroup' attributeGroup value.
void	setReqRespVersion(java.lang.String reqRespVersion) Set the 'ReqRespVersion' attribute value.
void	setVehicle(Vehicle vehicle) Set the 'Vehicle' element value.
void	setVehRentalDetails(VehicleRentalDetails vehRentalDetails) Set the 'VehRentalDetails' element value.
int	sizePaymentDetails() Get the number of 'PaymentDetails' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckInRQ

public CheckInRQ()

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 -

getConfID

public UniqueID getConfID()

Get the 'ConfID' element value. A confirmation number by which this reservation can be uniquely identified. In some cases the ConfID may be used in lieu of a ContractID, dependant on business needs.

Returns:

value

setConfID

public void setConfID(UniqueID confID)

Set the 'ConfID' element value. A confirmation number by which this reservation can be uniquely identified. In some cases the ConfID may be used in lieu of a ContractID, dependant on business needs.

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 -

getCustomer

public CustomerPrimaryAdditional getCustomer()

Get the 'Customer' element value. This is the rental customer's information and typically is not needed to be passed in this message.

Returns:

value

setCustomer

public void setCustomer(CustomerPrimaryAdditional customer)

Set the 'Customer' element value. This is the rental customer's information and typically is not needed to be passed in this message.

Parameters:

customer -

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 -

getPaymentDetails

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

Get the list of 'PaymentDetails' element items. This is used to obtain payment information. It repeats to allow for split payment methods.

Returns:

list

setPaymentDetails

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

Set the list of 'PaymentDetails' element items. This is used to obtain payment information. It repeats to allow for split payment methods.

Parameters:

list -

sizePaymentDetails

public int sizePaymentDetails()

Get the number of 'PaymentDetails' element items.

Returns:

count

addPaymentDetail

public void addPaymentDetail(PaymentDetail item)

Add a 'PaymentDetails' element item.

Parameters:

item -

getPaymentDetail

public PaymentDetail getPaymentDetail(int index)

Get 'PaymentDetails' element item by position.

Parameters:

index -

Returns:

item

clearPaymentDetails

public void clearPaymentDetails()

Remove all 'PaymentDetails' element items.

getVehicle

public Vehicle getVehicle()

Get the 'Vehicle' element value. Vehicle info including size, class, make/model, vehicle asset number, etc. This is the actual vehicle being rented.

Returns:

value

setVehicle

public void setVehicle(Vehicle vehicle)

Set the 'Vehicle' element value. Vehicle info including size, class, make/model, vehicle asset number, etc. This is the actual vehicle being rented.

Parameters:

vehicle -

getVehRentalDetails

public VehicleRentalDetails getVehRentalDetails()

Get the 'VehRentalDetails' element value. This is to provide information about the rental vehicle upon return (e.g., the mileage at the time of check-in).

Returns:

value

setVehRentalDetails

public void setVehRentalDetails(VehicleRentalDetails vehRentalDetails)

Set the 'VehRentalDetails' element value. This is to provide information about the rental vehicle upon return (e.g., the mileage at the time of check-in).

Parameters:

vehRentalDetails -

getPricedEquips

public CheckInRQ.PricedEquips getPricedEquips()

Get the 'PricedEquips' element value.

Returns:

value

setPricedEquips

public void setPricedEquips(CheckInRQ.PricedEquips pricedEquips)

Set the 'PricedEquips' element value.

Parameters:

pricedEquips -

getAdjustmentDetails

public CheckInRQ.AdjustmentDetails getAdjustmentDetails()

Get the 'AdjustmentDetails' element value.

Returns:

value

setAdjustmentDetails

public void setAdjustmentDetails(CheckInRQ.AdjustmentDetails adjustmentDetails)

Set the 'AdjustmentDetails' element value.

Parameters:

adjustmentDetails -

getOffLocationServiceDetails

public OffLocationServiceCore getOffLocationServiceDetails()

Get the 'OffLocationServiceDetails' element value. Used to capture collection information when vehicle is not returned to the rental facility.

Returns:

value

setOffLocationServiceDetails

public void setOffLocationServiceDetails(OffLocationServiceCore offLocationServiceDetails)

Set the 'OffLocationServiceDetails' element value. Used to capture collection information when vehicle is not returned to the rental facility.

Parameters:

offLocationServiceDetails -

getRemarks

public CheckInRQ.Remarks getRemarks()

Get the 'Remarks' element value.

Returns:

value

setRemarks

public void setRemarks(CheckInRQ.Remarks remarks)

Set the 'Remarks' element value.

Parameters:

remarks -

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.

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.

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 -