org.ota.vehicle
Class VehicleRentalCore

java.lang.Object
  org.ota.vehicle.VehicleRentalCore

Direct Known Subclasses:

RateRuleRS.VehRentalCore, VehicleRentalTransaction.PickUpReturnDetails

public class VehicleRentalCore
extends java.lang.Object

The VehicleRentalCoreType complex type identifies the data that is common, or core, to almost every transaction associated with the rental of a vehicle. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="VehicleRentalCoreType">
   <xs:sequence>
     <xs:element name="PickUpLocation" minOccurs="0" maxOccurs="2">
       <!-- Reference to inner class PickUpLocation -->
     </xs:element>
     <xs:element name="ReturnLocation" minOccurs="0">
       <!-- Reference to inner class ReturnLocation -->
     </xs:element>
   </xs:sequence>
   <xs:attribute type="xs:dateTime" use="optional" name="PickUpDateTime"/>
   <xs:attribute type="xs:dateTime" use="optional" name="ReturnDateTime"/>
   <xs:attribute type="xs:dateTime" use="optional" name="StartChargesDateTime"/>
   <xs:attribute type="xs:dateTime" use="optional" name="StopChargesDateTime"/>
   <xs:attribute type="xs:boolean" use="optional" name="OneWayIndicator"/>
   <xs:attribute type="xs:int" use="optional" name="MultiIslandRentalDays"/>
   <xs:attribute type="xs:int" use="optional" name="Quantity"/>
   <xs:attribute type="ns:DistanceUnitNameType" use="optional" name="DistUnitName"/>
 </xs:complexType>
 

Nested Class Summary

static class	VehicleRentalCore.PickUpLocation A code to identify the pick up location, along with an optional code context.
static class	VehicleRentalCore.ReturnLocation A code to identify the return location, along with an optional code context.

Constructor Summary

VehicleRentalCore()

Method Summary

void	addPickUpLocation(VehicleRentalCore.PickUpLocation item) Add a 'PickUpLocation' element item.
void	clearPickUpLocations() Remove all 'PickUpLocation' element items.
DistanceUnitName	getDistUnitName() Get the 'DistUnitName' attribute value.
java.lang.Integer	getMultiIslandRentalDays() Get the 'MultiIslandRentalDays' attribute value.
java.lang.Boolean	getOneWayIndicator() Get the 'OneWayIndicator' attribute value.
java.util.Date	getPickUpDateTime() Get the 'PickUpDateTime' attribute value.
VehicleRentalCore.PickUpLocation	getPickUpLocation(int index) Get 'PickUpLocation' element item by position.
java.util.List<VehicleRentalCore.PickUpLocation>	getPickUpLocations() Get the list of 'PickUpLocation' element items.
java.lang.Integer	getQuantity() Get the 'Quantity' attribute value.
java.util.Date	getReturnDateTime() Get the 'ReturnDateTime' attribute value.
VehicleRentalCore.ReturnLocation	getReturnLocation() Get the 'ReturnLocation' element value.
java.util.Date	getStartChargesDateTime() Get the 'StartChargesDateTime' attribute value.
java.util.Date	getStopChargesDateTime() Get the 'StopChargesDateTime' attribute value.
void	setDistUnitName(DistanceUnitName distUnitName) Set the 'DistUnitName' attribute value.
void	setMultiIslandRentalDays(java.lang.Integer multiIslandRentalDays) Set the 'MultiIslandRentalDays' attribute value.
void	setOneWayIndicator(java.lang.Boolean oneWayIndicator) Set the 'OneWayIndicator' attribute value.
void	setPickUpDateTime(java.util.Date pickUpDateTime) Set the 'PickUpDateTime' attribute value.
void	setPickUpLocations(java.util.List<VehicleRentalCore.PickUpLocation> list) Set the list of 'PickUpLocation' element items.
void	setQuantity(java.lang.Integer quantity) Set the 'Quantity' attribute value.
void	setReturnDateTime(java.util.Date returnDateTime) Set the 'ReturnDateTime' attribute value.
void	setReturnLocation(VehicleRentalCore.ReturnLocation returnLocation) Set the 'ReturnLocation' element value.
void	setStartChargesDateTime(java.util.Date startChargesDateTime) Set the 'StartChargesDateTime' attribute value.
void	setStopChargesDateTime(java.util.Date stopChargesDateTime) Set the 'StopChargesDateTime' attribute value.
int	sizePickUpLocations() Get the number of 'PickUpLocation' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

VehicleRentalCore

public VehicleRentalCore()

Method Detail

getPickUpLocations

public java.util.List<VehicleRentalCore.PickUpLocation> getPickUpLocations()

Get the list of 'PickUpLocation' element items.

Returns:

list

setPickUpLocations

public void setPickUpLocations(java.util.List<VehicleRentalCore.PickUpLocation> list)

Set the list of 'PickUpLocation' element items.

Parameters:

list -

sizePickUpLocations

public int sizePickUpLocations()

Get the number of 'PickUpLocation' element items.

Returns:

count

addPickUpLocation

public void addPickUpLocation(VehicleRentalCore.PickUpLocation item)

Add a 'PickUpLocation' element item.

Parameters:

item -

getPickUpLocation

public VehicleRentalCore.PickUpLocation getPickUpLocation(int index)

Get 'PickUpLocation' element item by position.

Parameters:

index -

Returns:

item

clearPickUpLocations

public void clearPickUpLocations()

Remove all 'PickUpLocation' element items.

getReturnLocation

public VehicleRentalCore.ReturnLocation getReturnLocation()

Get the 'ReturnLocation' element value.

Returns:

value

setReturnLocation

public void setReturnLocation(VehicleRentalCore.ReturnLocation returnLocation)

Set the 'ReturnLocation' element value.

Parameters:

returnLocation -

getPickUpDateTime

public java.util.Date getPickUpDateTime()

Get the 'PickUpDateTime' attribute value.

Returns:

value

setPickUpDateTime

public void setPickUpDateTime(java.util.Date pickUpDateTime)

Set the 'PickUpDateTime' attribute value.

Parameters:

pickUpDateTime -

getReturnDateTime

public java.util.Date getReturnDateTime()

Get the 'ReturnDateTime' attribute value.

Returns:

value

setReturnDateTime

public void setReturnDateTime(java.util.Date returnDateTime)

Set the 'ReturnDateTime' attribute value.

Parameters:

returnDateTime -

getStartChargesDateTime

public java.util.Date getStartChargesDateTime()

Get the 'StartChargesDateTime' attribute value. Used when a charge has a delayed start (e.g. if a vehicle is checked-out Sunday night, but actual charges start Monday or planned system down-time allowed a check-out before customer plans to retrieve vehicle or when an additional service is added after a rental has been started and/or will terminate before the rental is completed).

Returns:

value

setStartChargesDateTime

public void setStartChargesDateTime(java.util.Date startChargesDateTime)

Set the 'StartChargesDateTime' attribute value. Used when a charge has a delayed start (e.g. if a vehicle is checked-out Sunday night, but actual charges start Monday or planned system down-time allowed a check-out before customer plans to retrieve vehicle or when an additional service is added after a rental has been started and/or will terminate before the rental is completed).

Parameters:

startChargesDateTime -

getStopChargesDateTime

public java.util.Date getStopChargesDateTime()

Get the 'StopChargesDateTime' attribute value. Used when a charge has a delayed stop (e.g. actual charges stop Sunday but the vehicle is checked-in Monday morning or if the system was down when customer returned vehicle or when an additional service is added after a rental has been started and/or will terminate before the rental is completed).

Returns:

value

setStopChargesDateTime

public void setStopChargesDateTime(java.util.Date stopChargesDateTime)

Set the 'StopChargesDateTime' attribute value. Used when a charge has a delayed stop (e.g. actual charges stop Sunday but the vehicle is checked-in Monday morning or if the system was down when customer returned vehicle or when an additional service is added after a rental has been started and/or will terminate before the rental is completed).

Parameters:

stopChargesDateTime -

getOneWayIndicator

public java.lang.Boolean getOneWayIndicator()

Get the 'OneWayIndicator' attribute value. When true, indicates a one-way rental. This may also be discerned using the PickUpLocation and the ReturnLocation.

Returns:

value

setOneWayIndicator

public void setOneWayIndicator(java.lang.Boolean oneWayIndicator)

Set the 'OneWayIndicator' attribute value. When true, indicates a one-way rental. This may also be discerned using the PickUpLocation and the ReturnLocation.

Parameters:

oneWayIndicator -

getMultiIslandRentalDays

public java.lang.Integer getMultiIslandRentalDays()

Get the 'MultiIslandRentalDays' attribute value. Indicates the total number of rental days on all islands (e.g., if traveling for 7 days, but using a vehicle on one island for 3 days and on another for 2 days, the multi island rental days is 5).

Returns:

value

setMultiIslandRentalDays

public void setMultiIslandRentalDays(java.lang.Integer multiIslandRentalDays)

Set the 'MultiIslandRentalDays' attribute value. Indicates the total number of rental days on all islands (e.g., if traveling for 7 days, but using a vehicle on one island for 3 days and on another for 2 days, the multi island rental days is 5).

Parameters:

multiIslandRentalDays -

getQuantity

public java.lang.Integer getQuantity()

Get the 'Quantity' attribute value. Provides the distance between the pick up and return locations.

Returns:

value

setQuantity

public void setQuantity(java.lang.Integer quantity)

Set the 'Quantity' attribute value. Provides the distance between the pick up and return locations.

Parameters:

quantity -

getDistUnitName

public DistanceUnitName getDistUnitName()

Get the 'DistUnitName' attribute value. Provides the unit of measure to which the quantity refers.

Returns:

value

setDistUnitName

public void setDistUnitName(DistanceUnitName distUnitName)

Set the 'DistUnitName' attribute value. Provides the unit of measure to which the quantity refers.

Parameters:

distUnitName -