org.ota.vehicle
Class ExchangeRS

java.lang.Object
  org.ota.vehicle.ExchangeRS

public class ExchangeRS
extends java.lang.Object

This message is used to return information about the vehicles involved in the exchange as well as a recap of the rate information. 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_VehExchangeRS">
   <xs:complexType>
     <xs:choice>
       <xs:sequence>
         <xs:element type="ns:SuccessType" name="Success"/>
         <xs:element type="ns:WarningsType" name="Warnings" 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="ExchangeLocationDetails" minOccurs="0">
           <!-- Reference to inner class ExchangeLocationDetails -->
         </xs:element>
         <xs:element name="Vehicle" maxOccurs="9">
           <!-- Reference to inner class Vehicle -->
         </xs:element>
         <xs:element name="AdjustmentDetails" minOccurs="0">
           <!-- Reference to inner class AdjustmentDetails -->
         </xs:element>
         <xs:element type="ns:VehicleRentalRateType" name="RentalRate" minOccurs="0"/>
         <xs:element name="Fees" minOccurs="0">
           <!-- Reference to inner class Fees -->
         </xs:element>
         <xs:element name="TotalCharge" minOccurs="0">
           <xs:complexType>
             <xs:attributeGroup ref="ns:VehicleTotalChargeGroup"/>
           </xs:complexType>
         </xs:element>
         <xs:element name="PricedCoverages" minOccurs="0">
           <!-- Reference to inner class PricedCoverages -->
         </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:sequence>
       <xs:element type="ns:ErrorsType" name="Errors"/>
     </xs:choice>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
     <xs:attributeGroup ref="ns:RentalActionGroup"/>
   </xs:complexType>
 </xs:element>
 
 <xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="SuccessType"/>
 

Nested Class Summary

static class	ExchangeRS.AdjustmentDetails Collection of adjustments.
static class	ExchangeRS.ExchangeLocationDetails Provides location details where the vehicle was exchanged.
static class	ExchangeRS.Fees A collection of fees associated with this rental.
static class	ExchangeRS.PricedCoverages A collection of coverages associated with this vehicle.
static class	ExchangeRS.Remarks A collection of remarks.
static class	ExchangeRS.Vehicle Vehicle info including size, class, make/model, vehicle asset number, etc.

Constructor Summary

ExchangeRS()

Method Summary

void	addVehicle(ExchangeRS.Vehicle item) Add a 'Vehicle' element item.
void	clearChoiceSelect() Clear the choice selection.
void	clearVehicles() Remove all 'Vehicle' element items.
ExchangeRS.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.
Errors	getErrors() Get the 'Errors' element value.
ExchangeRS.ExchangeLocationDetails	getExchangeLocationDetails() Get the 'ExchangeLocationDetails' element value.
Paragraph	getExchangeReason() Get the 'ExchangeReason' element value.
ExchangeRS.Fees	getFees() Get the 'Fees' element value.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
VehicleRentalCore	getPickUpReturnDetails() Get the 'PickUpReturnDetails' element value.
ExchangeRS.PricedCoverages	getPricedCoverages() Get the 'PricedCoverages' element value.
ExchangeRS.Remarks	getRemarks() Get the 'Remarks' element value.
RentalActionGroup	getRentalActionGroup() Get the 'RentalActionGroup' attributeGroup value.
VehicleRentalRate	getRentalRate() Get the 'RentalRate' element value.
VehicleTotalChargeGroup	getTotalCharge() Get the 'VehicleTotalChargeGroup' attributeGroup value.
ExchangeRS.Vehicle	getVehicle(int index) Get 'Vehicle' element item by position.
java.util.List<ExchangeRS.Vehicle>	getVehicles() Get the list of 'Vehicle' element items.
Warnings	getWarnings() Get the 'Warnings' element value.
boolean	ifErrors() Check if Errors is current selection for choice.
boolean	ifSuccess() Check if Success is current selection for choice.
void	setAdjustmentDetails(ExchangeRS.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	setErrors(Errors errors) Set the 'Errors' element value.
void	setExchangeLocationDetails(ExchangeRS.ExchangeLocationDetails exchangeLocationDetails) Set the 'ExchangeLocationDetails' element value.
void	setExchangeReason(Paragraph exchangeReason) Set the 'ExchangeReason' element value.
void	setFees(ExchangeRS.Fees fees) Set the 'Fees' element value.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setPickUpReturnDetails(VehicleRentalCore pickUpReturnDetails) Set the 'PickUpReturnDetails' element value.
void	setPricedCoverages(ExchangeRS.PricedCoverages pricedCoverages) Set the 'PricedCoverages' element value.
void	setRemarks(ExchangeRS.Remarks remarks) Set the 'Remarks' element value.
void	setRentalActionGroup(RentalActionGroup rentalActionGroup) Set the 'RentalActionGroup' attributeGroup value.
void	setRentalRate(VehicleRentalRate rentalRate) Set the 'RentalRate' element value.
void	setTotalCharge(VehicleTotalChargeGroup totalCharge) Set the 'VehicleTotalChargeGroup' attributeGroup value.
void	setVehicles(java.util.List<ExchangeRS.Vehicle> list) Set the list of 'Vehicle' element items.
void	setWarnings(Warnings warnings) Set the 'Warnings' element value.
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

ExchangeRS

public ExchangeRS()

Method Detail

clearChoiceSelect

public void clearChoiceSelect()

Clear the choice selection.

ifSuccess

public boolean ifSuccess()

Check if Success is current selection for choice.

Returns:

true if selection, false if not

getWarnings

public Warnings getWarnings()

Get the 'Warnings' element value.

Returns:

value

setWarnings

public void setWarnings(Warnings warnings)

Set the 'Warnings' element value.

Parameters:

warnings -

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. Details regarding the customer.

Returns:

value

setCustomer

public void setCustomer(CustomerPrimaryAdditional customer)

Set the 'Customer' element value. Details regarding the customer.

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 -

getExchangeLocationDetails

public ExchangeRS.ExchangeLocationDetails getExchangeLocationDetails()

Get the 'ExchangeLocationDetails' element value.

Returns:

value

setExchangeLocationDetails

public void setExchangeLocationDetails(ExchangeRS.ExchangeLocationDetails exchangeLocationDetails)

Set the 'ExchangeLocationDetails' element value.

Parameters:

exchangeLocationDetails -

getVehicles

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

Get the list of 'Vehicle' element items.

Returns:

list

setVehicles

public void setVehicles(java.util.List<ExchangeRS.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(ExchangeRS.Vehicle item)

Add a 'Vehicle' element item.

Parameters:

item -

getVehicle

public ExchangeRS.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 ExchangeRS.AdjustmentDetails getAdjustmentDetails()

Get the 'AdjustmentDetails' element value.

Returns:

value

setAdjustmentDetails

public void setAdjustmentDetails(ExchangeRS.AdjustmentDetails adjustmentDetails)

Set the 'AdjustmentDetails' element value.

Parameters:

adjustmentDetails -

getRentalRate

public VehicleRentalRate getRentalRate()

Get the 'RentalRate' element value. This describes time, mileage and other charges for a specific rental agreement.

Returns:

value

setRentalRate

public void setRentalRate(VehicleRentalRate rentalRate)

Set the 'RentalRate' element value. This describes time, mileage and other charges for a specific rental agreement.

Parameters:

rentalRate -

getFees

public ExchangeRS.Fees getFees()

Get the 'Fees' element value.

Returns:

value

setFees

public void setFees(ExchangeRS.Fees fees)

Set the 'Fees' element value.

Parameters:

fees -

getTotalCharge

public VehicleTotalChargeGroup getTotalCharge()

Get the 'VehicleTotalChargeGroup' attributeGroup value.

Returns:

value

setTotalCharge

public void setTotalCharge(VehicleTotalChargeGroup totalCharge)

Set the 'VehicleTotalChargeGroup' attributeGroup value.

Parameters:

totalCharge -

getPricedCoverages

public ExchangeRS.PricedCoverages getPricedCoverages()

Get the 'PricedCoverages' element value.

Returns:

value

setPricedCoverages

public void setPricedCoverages(ExchangeRS.PricedCoverages pricedCoverages)

Set the 'PricedCoverages' element value.

Parameters:

pricedCoverages -

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 ExchangeRS.Remarks getRemarks()

Get the 'Remarks' element value.

Returns:

value

setRemarks

public void setRemarks(ExchangeRS.Remarks remarks)

Set the 'Remarks' element value.

Parameters:

remarks -

ifErrors

public boolean ifErrors()

Check if Errors is current selection for choice.

Returns:

true if selection, false if not

getErrors

public Errors getErrors()

Get the 'Errors' element value.

Returns:

value

setErrors

public void setErrors(Errors errors)

Set the 'Errors' element value.

Parameters:

errors -

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 typically echoes back the RentalActionCode from the request and may provide an updated RentalAgreementStatusCode based on the request message.

Returns:

value

setRentalActionGroup

public void setRentalActionGroup(RentalActionGroup rentalActionGroup)

Set the 'RentalActionGroup' attributeGroup value. This typically echoes back the RentalActionCode from the request and may provide an updated RentalAgreementStatusCode based on the request message.

Parameters:

rentalActionGroup -