org.ota.vehicle
Class ExchangeRQ

java.lang.Object
  org.ota.vehicle.ExchangeRQ

public class ExchangeRQ
extends java.lang.Object

This message will allow a customer to exchange a vehicle that has already been checked out. The message accommodates the inclusion of information about the vehicle being exchanged as well as details of the vehicle being given in exchange. 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_VehExchangeRQ">
   <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 name="ExchangeLocation" minOccurs="0">
         <!-- Reference to inner class ExchangeLocation -->
       </xs:element>
       <xs:element name="Vehicle" maxOccurs="2">
         <!-- Reference to inner class Vehicle -->
       </xs:element>
       <xs:element name="AdjustmentDetails" minOccurs="0">
         <!-- Reference to inner class AdjustmentDetails -->
       </xs:element>
       <xs:element type="ns:ParagraphType" name="ExchangeReason" minOccurs="0"/>
       <xs:element name="Remarks" minOccurs="0">
         <!-- Reference to inner class Remarks -->
       </xs:element>
       <xs:element ref="ns:TPA_Extensions" 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: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	ExchangeRQ.AdjustmentDetails Collection of adjustments.
static class	ExchangeRQ.ExchangeLocation Location where the vehicle was exchanged.
static class	ExchangeRQ.Remarks A collection of remarks.
static class	ExchangeRQ.Vehicle Vehicle info including size, class, make/model, vehicle asset number, etc.

Constructor Summary

ExchangeRQ()

Method Summary

void	addVehicle(ExchangeRQ.Vehicle item) Add a 'Vehicle' element item.
void	clearVehicles() Remove all 'Vehicle' element items.
ExchangeRQ.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.
ExchangeRQ.ExchangeLocation	getExchangeLocation() Get the 'ExchangeLocation' element value.
Paragraph	getExchangeReason() Get the 'ExchangeReason' element value.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
VehicleRentalCore	getPickUpReturnDetails() Get the 'PickUpReturnDetails' element value.
POS	getPOS() Get the 'POS' element value.
ExchangeRQ.Remarks	getRemarks() Get the 'Remarks' element value.
RentalActionGroup	getRentalActionGroup() Get the 'RentalActionGroup' attributeGroup value.
java.lang.String	getReqRespVersion() Get the 'ReqRespVersion' attribute value.
TPAExtensions	getTPAExtensions() Get the 'TPA_Extensions' element value.
ExchangeRQ.Vehicle	getVehicle(int index) Get 'Vehicle' element item by position.
java.util.List<ExchangeRQ.Vehicle>	getVehicles() Get the list of 'Vehicle' element items.
void	setAdjustmentDetails(ExchangeRQ.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	setExchangeLocation(ExchangeRQ.ExchangeLocation exchangeLocation) Set the 'ExchangeLocation' element value.
void	setExchangeReason(Paragraph exchangeReason) Set the 'ExchangeReason' 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	setRemarks(ExchangeRQ.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	setTPAExtensions(TPAExtensions TPAExtensions) Set the 'TPA_Extensions' element value.
void	setVehicles(java.util.List<ExchangeRQ.Vehicle> list) Set the list of 'Vehicle' element items.
int	sizeVehicles() Get the number of 'Vehicle' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExchangeRQ

public ExchangeRQ()

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, dependent 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, dependent 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 -

getExchangeLocation

public ExchangeRQ.ExchangeLocation getExchangeLocation()

Get the 'ExchangeLocation' element value.

Returns:

value

setExchangeLocation

public void setExchangeLocation(ExchangeRQ.ExchangeLocation exchangeLocation)

Set the 'ExchangeLocation' element value.

Parameters:

exchangeLocation -

getVehicles

public java.util.List<ExchangeRQ.Vehicle> getVehicles()

Get the list of 'Vehicle' element items.

Returns:

list

setVehicles

public void setVehicles(java.util.List<ExchangeRQ.Vehicle> list)

Set the list of 'Vehicle' element items.

Parameters:

list -

sizeVehicles

public int sizeVehicles()

Get the number of 'Vehicle' element items.

Returns:

count

addVehicle

public void addVehicle(ExchangeRQ.Vehicle item)

Add a 'Vehicle' element item.

Parameters:

item -

getVehicle

public ExchangeRQ.Vehicle getVehicle(int index)

Get 'Vehicle' element item by position.

Parameters:

index -

Returns:

item

clearVehicles

public void clearVehicles()

Remove all 'Vehicle' element items.

getAdjustmentDetails

public ExchangeRQ.AdjustmentDetails getAdjustmentDetails()

Get the 'AdjustmentDetails' element value.

Returns:

value

setAdjustmentDetails

public void setAdjustmentDetails(ExchangeRQ.AdjustmentDetails adjustmentDetails)

Set the 'AdjustmentDetails' element value.

Parameters:

adjustmentDetails -

getExchangeReason

public Paragraph getExchangeReason()

Get the 'ExchangeReason' element value. Used to indicate reasons for vehicle exchange.

Returns:

value

setExchangeReason

public void setExchangeReason(Paragraph exchangeReason)

Set the 'ExchangeReason' element value. Used to indicate reasons for vehicle exchange.

Parameters:

exchangeReason -

getRemarks

public ExchangeRQ.Remarks getRemarks()

Get the 'Remarks' element value.

Returns:

value

setRemarks

public void setRemarks(ExchangeRQ.Remarks remarks)

Set the 'Remarks' element value.

Parameters:

remarks -

getTPAExtensions

public TPAExtensions getTPAExtensions()

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

setTPAExtensions

public void setTPAExtensions(TPAExtensions TPAExtensions)

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:

TPAExtensions -

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 -