org.ota.vehicle
Class LocSearchRQ

java.lang.Object
  org.ota.vehicle.LocSearchRQ

public class LocSearchRQ
extends java.lang.Object

Vehicle Location Search request will allow car rental customers to request car rental provider(s) to return location(s) available. The search will be based on longitude/latitude of the location. Requests can be based on providing one or many of the following: longitude/latitude, address, telephone number, reference point, the actual code of the location, hotel, and/or radius. 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_VehLocSearchRQ">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:POS_Type" name="POS"/>
       <xs:element type="ns:ItemSearchCriterionType" name="VehLocSearchCriterion" maxOccurs="5"/>
       <xs:element type="ns:CompanyNameType" name="Vendor" minOccurs="0"/>
       <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
     </xs:sequence>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
     <xs:attributeGroup ref="ns:MaxResponsesGroup"/>
     <xs:attributeGroup ref="ns:ReqRespVersion"/>
     <xs:attribute type="xs:boolean" use="optional" name="JustAddressPhone"/>
   </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="MaxResponsesGroup">
   <xs:attribute type="xs:string" use="optional" name="MaxResponses"/>
 </xs:attributeGroup>
 
 <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>
 

Constructor Summary

LocSearchRQ()

Method Summary

void	addVehLocSearchCriterion(ItemSearchCriterion item) Add a 'VehLocSearchCriterion' element item.
void	clearVehLocSearchCriterions() Remove all 'VehLocSearchCriterion' element items.
java.lang.Boolean	getJustAddressPhone() Get the 'JustAddressPhone' attribute value.
java.lang.String	getMaxResponses() Get the 'MaxResponses' attribute value.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
POS	getPOS() Get the 'POS' element value.
java.lang.String	getReqRespVersion() Get the 'ReqRespVersion' attribute value.
TPAExtensions	getTPAExtensions() Get the 'TPA_Extensions' element value.
ItemSearchCriterion	getVehLocSearchCriterion(int index) Get 'VehLocSearchCriterion' element item by position.
java.util.List<ItemSearchCriterion>	getVehLocSearchCriterions() Get the list of 'VehLocSearchCriterion' element items.
CompanyName	getVendor() Get the 'Vendor' element value.
void	setJustAddressPhone(java.lang.Boolean justAddressPhone) Set the 'JustAddressPhone' attribute value.
void	setMaxResponses(java.lang.String maxResponses) Set the 'MaxResponses' attribute value.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setPOS(POS POS) Set the 'POS' element value.
void	setReqRespVersion(java.lang.String reqRespVersion) Set the 'ReqRespVersion' attribute value.
void	setTPAExtensions(TPAExtensions TPAExtensions) Set the 'TPA_Extensions' element value.
void	setVehLocSearchCriterions(java.util.List<ItemSearchCriterion> list) Set the list of 'VehLocSearchCriterion' element items.
void	setVendor(CompanyName vendor) Set the 'Vendor' element value.
int	sizeVehLocSearchCriterions() Get the number of 'VehLocSearchCriterion' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocSearchRQ

public LocSearchRQ()

Method Detail

getPOS

public POS getPOS()

Get the 'POS' element value. Point of Sale Identification. Identification number of the vendor that has made the location search request and agency number assigned by IATA, ARC, ERSP or TID.

Returns:

value

setPOS

public void setPOS(POS POS)

Set the 'POS' element value. Point of Sale Identification. Identification number of the vendor that has made the location search request and agency number assigned by IATA, ARC, ERSP or TID.

Parameters:

POS -

getVehLocSearchCriterions

public java.util.List<ItemSearchCriterion> getVehLocSearchCriterions()

Get the list of 'VehLocSearchCriterion' element items. A collection of search parameters to be used in the search.

Returns:

list

setVehLocSearchCriterions

public void setVehLocSearchCriterions(java.util.List<ItemSearchCriterion> list)

Set the list of 'VehLocSearchCriterion' element items. A collection of search parameters to be used in the search.

Parameters:

list -

sizeVehLocSearchCriterions

public int sizeVehLocSearchCriterions()

Get the number of 'VehLocSearchCriterion' element items.

Returns:

count

addVehLocSearchCriterion

public void addVehLocSearchCriterion(ItemSearchCriterion item)

Add a 'VehLocSearchCriterion' element item.

Parameters:

item -

getVehLocSearchCriterion

public ItemSearchCriterion getVehLocSearchCriterion(int index)

Get 'VehLocSearchCriterion' element item by position.

Parameters:

index -

Returns:

item

clearVehLocSearchCriterions

public void clearVehLocSearchCriterions()

Remove all 'VehLocSearchCriterion' element items.

getVendor

public CompanyName getVendor()

Get the 'Vendor' element value. Information on the vendor to be used as part of the search. If this information is provided then only locations belonging to this vendor should be made available in the response.

Returns:

value

setVendor

public void setVendor(CompanyName vendor)

Set the 'Vendor' element value. Information on the vendor to be used as part of the search. If this information is provided then only locations belonging to this vendor should be made available in the response.

Parameters:

vendor -

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 -

getMaxResponses

public java.lang.String getMaxResponses()

Get the 'MaxResponses' attribute value. A positive integer value that indicates the maximum number of responses desired in the return.

Returns:

value

setMaxResponses

public void setMaxResponses(java.lang.String maxResponses)

Set the 'MaxResponses' attribute value. A positive integer value that indicates the maximum number of responses desired in the return.

Parameters:

maxResponses -

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 -

getJustAddressPhone

public java.lang.Boolean getJustAddressPhone()

Get the 'JustAddressPhone' attribute value. This attribute can be used to indicate how much information should be returned about a location matching the search criteria. If set to true, only the location address and phone numbers will be provided. If set to false, or omitted, all information about the location of the facility will be provided. false

Returns:

value

setJustAddressPhone

public void setJustAddressPhone(java.lang.Boolean justAddressPhone)

Set the 'JustAddressPhone' attribute value. This attribute can be used to indicate how much information should be returned about a location matching the search criteria. If set to true, only the location address and phone numbers will be provided. If set to false, or omitted, all information about the location of the facility will be provided. false

Parameters:

justAddressPhone -