org.ota.rail
Class AvailRQ

java.lang.Object
  org.ota.rail.AvailRQ

public class AvailRQ
extends java.lang.Object

The Availability Request message requests Train Availability for a station pair on a specific date for a specific number and type of passengers. Optional request information can include: - Time / Time Window - Connecting cities. - Client Preferences. The request can be narrowed to request availability for a specific train . The ResponseType attribute allows the user to specify that the response be restricted to Schedules, Fares or full Availability. If the ResponseType is 'Fares', the response will comprise a list of all fares from the Origin to the Destination. If the ResponseType is 'Schedules', the response will comprise a list of all train departures from the Origin to the Destination. If the ResponseType is 'Availability', the response will comprise a list of available train departures from the Origin to the Destination and, where the responding system has this facility, valid fares available on those departures. 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_RailAvailRQ">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:POS_Type" name="POS" minOccurs="0"/>
       <xs:element name="RailAvailInfo">
         <xs:complexType>
           <xs:sequence>
             <xs:element type="ns:OriginDestinationInformationType" name="OriginDestinationInformation"/>
             <xs:element name="PassengerType" minOccurs="0" maxOccurs="5">
               <xs:complexType>
                 <xs:attributeGroup ref="ns:TravelerCountGroup"/>
               </xs:complexType>
             </xs:element>
             <xs:element type="ns:TravelDateTimeType" name="ReturnDateTime" minOccurs="0"/>
             <xs:element type="ns:RailAvailPrefsType" name="RailPrefs" minOccurs="0">
               <!-- Reference to inner class RailPrefs -->
             </xs:element>
             <xs:element name="FareQualifier" minOccurs="0">
               <xs:complexType>
                 <xs:attributeGroup ref="ns:RateQualifierCoreGroup"/>
               </xs:complexType>
             </xs:element>
           </xs:sequence>
           <xs:attribute type="xs:int" use="optional" name="MaxChanges"/>
           <xs:attribute type="xs:string" use="optional" name="TrainNumber"/>
           <xs:attribute type="xs:string" use="optional" name="Class"/>
           <xs:attribute type="xs:boolean" use="optional" name="BulletinRequired"/>
         </xs:complexType>
       </xs:element>
     </xs:sequence>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
     <xs:attributeGroup ref="ns:MaxResponsesGroup"/>
     <xs:attribute use="required" name="ResponseType">
       <xs:simpleType>
         <!-- Reference to inner class Response -->
       </xs:simpleType>
     </xs:attribute>
   </xs:complexType>
 </xs:element>
 
 <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>
 

Nested Class Summary

static class	AvailRQ.RailPrefs Specifies the preferences qualifying the availability request.
static class	AvailRQ.Response Schema fragment(s) for this class:

Constructor Summary

AvailRQ()

Method Summary

void	addRailAvailInfoPassenger(TravelerCountGroup item) Add a 'PassengerType' element item.
void	clearRailAvailInfoPassengers() Remove all 'PassengerType' element items.
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	getRailAvailInfo_Class() Get the 'Class' attribute value.
java.lang.Boolean	getRailAvailInfoBulletinRequired() Get the 'BulletinRequired' attribute value.
RateQualifierCoreGroup	getRailAvailInfoFareQualifier() Get the 'RateQualifierCoreGroup' attributeGroup value.
java.lang.Integer	getRailAvailInfoMaxChanges() Get the 'MaxChanges' attribute value.
OriginDestinationInformation	getRailAvailInfoOriginDestinationInformation() Get the 'OriginDestinationInformation' element value.
TravelerCountGroup	getRailAvailInfoPassenger(int index) Get 'PassengerType' element item by position.
java.util.List<TravelerCountGroup>	getRailAvailInfoPassengers() Get the list of 'PassengerType' element items.
TravelDateTime	getRailAvailInfoReturnDateTime() Get the 'ReturnDateTime' element value.
java.lang.String	getRailAvailInfoTrainNumber() Get the 'TrainNumber' attribute value.
AvailRQ.RailPrefs	getRailPrefs() Get the 'RailPrefs' element value.
AvailRQ.Response	getResponse() Get the 'ResponseType' 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	setRailAvailInfo_Class(java.lang.String railAvailInfo_Class) Set the 'Class' attribute value.
void	setRailAvailInfoBulletinRequired(java.lang.Boolean railAvailInfoBulletinRequired) Set the 'BulletinRequired' attribute value.
void	setRailAvailInfoFareQualifier(RateQualifierCoreGroup railAvailInfoFareQualifier) Set the 'RateQualifierCoreGroup' attributeGroup value.
void	setRailAvailInfoMaxChanges(java.lang.Integer railAvailInfoMaxChanges) Set the 'MaxChanges' attribute value.
void	setRailAvailInfoOriginDestinationInformation(OriginDestinationInformation railAvailInfoOriginDestinationInformation) Set the 'OriginDestinationInformation' element value.
void	setRailAvailInfoPassengers(java.util.List<TravelerCountGroup> list) Set the list of 'PassengerType' element items.
void	setRailAvailInfoReturnDateTime(TravelDateTime railAvailInfoReturnDateTime) Set the 'ReturnDateTime' element value.
void	setRailAvailInfoTrainNumber(java.lang.String railAvailInfoTrainNumber) Set the 'TrainNumber' attribute value.
void	setRailPrefs(AvailRQ.RailPrefs railPrefs) Set the 'RailPrefs' element value.
void	setResponse(AvailRQ.Response response) Set the 'ResponseType' attribute value.
int	sizeRailAvailInfoPassengers() Get the number of 'PassengerType' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailRQ

public AvailRQ()

Method Detail

getPOS

public POS getPOS()

Get the 'POS' element value. Point of Sale Identification. Identification number of the vendor that has made the rail availability request and agency number assigned by IATA, ARC, ESRP 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 rail availability request and agency number assigned by IATA, ARC, ESRP or TID.

Parameters:

POS -

getRailAvailInfoOriginDestinationInformation

public OriginDestinationInformation getRailAvailInfoOriginDestinationInformation()

Get the 'OriginDestinationInformation' element value. Information on the locations between which availability is to be checked.

Returns:

value

setRailAvailInfoOriginDestinationInformation

public void setRailAvailInfoOriginDestinationInformation(OriginDestinationInformation railAvailInfoOriginDestinationInformation)

Set the 'OriginDestinationInformation' element value. Information on the locations between which availability is to be checked.

Parameters:

railAvailInfoOriginDestinationInformation -

getRailAvailInfoPassengers

public java.util.List<TravelerCountGroup> getRailAvailInfoPassengers()

Get the list of 'PassengerType' element items. Identifies the number of passengers by category.

Returns:

list

setRailAvailInfoPassengers

public void setRailAvailInfoPassengers(java.util.List<TravelerCountGroup> list)

Set the list of 'PassengerType' element items. Identifies the number of passengers by category.

Parameters:

list -

sizeRailAvailInfoPassengers

public int sizeRailAvailInfoPassengers()

Get the number of 'PassengerType' element items.

Returns:

count

addRailAvailInfoPassenger

public void addRailAvailInfoPassenger(TravelerCountGroup item)

Add a 'PassengerType' element item.

Parameters:

item -

getRailAvailInfoPassenger

public TravelerCountGroup getRailAvailInfoPassenger(int index)

Get 'PassengerType' element item by position.

Parameters:

index -

Returns:

item

clearRailAvailInfoPassengers

public void clearRailAvailInfoPassengers()

Remove all 'PassengerType' element items.

getRailAvailInfoReturnDateTime

public TravelDateTime getRailAvailInfoReturnDateTime()

Get the 'ReturnDateTime' element value. Indicates the date and time search criteria for the return journey.

Returns:

value

setRailAvailInfoReturnDateTime

public void setRailAvailInfoReturnDateTime(TravelDateTime railAvailInfoReturnDateTime)

Set the 'ReturnDateTime' element value. Indicates the date and time search criteria for the return journey.

Parameters:

railAvailInfoReturnDateTime -

getRailPrefs

public AvailRQ.RailPrefs getRailPrefs()

Get the 'RailPrefs' element value. Specifies the passenger requirements for an Availability search.

Returns:

value

setRailPrefs

public void setRailPrefs(AvailRQ.RailPrefs railPrefs)

Set the 'RailPrefs' element value. Specifies the passenger requirements for an Availability search.

Parameters:

railPrefs -

getRailAvailInfoFareQualifier

public RateQualifierCoreGroup getRailAvailInfoFareQualifier()

Get the 'RateQualifierCoreGroup' attributeGroup value. Indicates the type of fares of interest to the customer, along with any discount number or promotional codes that may affect the fare.

Returns:

value

setRailAvailInfoFareQualifier

public void setRailAvailInfoFareQualifier(RateQualifierCoreGroup railAvailInfoFareQualifier)

Set the 'RateQualifierCoreGroup' attributeGroup value. Indicates the type of fares of interest to the customer, along with any discount number or promotional codes that may affect the fare.

Parameters:

railAvailInfoFareQualifier -

getRailAvailInfoMaxChanges

public java.lang.Integer getRailAvailInfoMaxChanges()

Get the 'MaxChanges' attribute value. Indicates the maximum number of connections (if 0, then direct)

Returns:

value

setRailAvailInfoMaxChanges

public void setRailAvailInfoMaxChanges(java.lang.Integer railAvailInfoMaxChanges)

Set the 'MaxChanges' attribute value. Indicates the maximum number of connections (if 0, then direct)

Parameters:

railAvailInfoMaxChanges -

getRailAvailInfoTrainNumber

public java.lang.String getRailAvailInfoTrainNumber()

Get the 'TrainNumber' attribute value.

Returns:

value

setRailAvailInfoTrainNumber

public void setRailAvailInfoTrainNumber(java.lang.String railAvailInfoTrainNumber)

Set the 'TrainNumber' attribute value.

Parameters:

railAvailInfoTrainNumber -

getRailAvailInfo_Class

public java.lang.String getRailAvailInfo_Class()

Get the 'Class' attribute value.

Returns:

value

setRailAvailInfo_Class

public void setRailAvailInfo_Class(java.lang.String railAvailInfo_Class)

Set the 'Class' attribute value.

Parameters:

railAvailInfo_Class -

getRailAvailInfoBulletinRequired

public java.lang.Boolean getRailAvailInfoBulletinRequired()

Get the 'BulletinRequired' attribute value. true

Returns:

value

setRailAvailInfoBulletinRequired

public void setRailAvailInfoBulletinRequired(java.lang.Boolean railAvailInfoBulletinRequired)

Set the 'BulletinRequired' attribute value. true

Parameters:

railAvailInfoBulletinRequired -

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 -

getResponse

public AvailRQ.Response getResponse()

Get the 'ResponseType' attribute value. Indicates whether the response should be restricted to Fares or Schedules or provide Availability including, where applicable, Fares.

Returns:

value

setResponse

public void setResponse(AvailRQ.Response response)

Set the 'ResponseType' attribute value. Indicates whether the response should be restricted to Fares or Schedules or provide Availability including, where applicable, Fares.

Parameters:

response -