org.ota.rail
Class AvailRS

java.lang.Object
  org.ota.rail.AvailRS

public class AvailRS
extends java.lang.Object

The Availability Response message contains Train Availability for a station pair on a specific date. A set of OriginDestinationOptions is returned, each of which contains one or more (connecting) trains that serve the city pair. The ResponseType attribute in the Request message specifies whether the response is restricted to Schedules or 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_RailAvailRS">
   <xs:complexType>
     <xs:choice>
       <xs:sequence>
         <xs:element type="ns:SuccessType" name="Success"/>
         <xs:element type="ns:WarningsType" name="Warnings" minOccurs="0"/>
         <xs:element name="OriginDestinationOptions" minOccurs="0">
           <!-- Reference to inner class OriginDestinationOptions -->
         </xs:element>
         <xs:element name="Fares" minOccurs="0">
           <!-- Reference to inner class Fares -->
         </xs:element>
       </xs:sequence>
       <xs:element type="ns:ErrorsType" name="Errors"/>
     </xs:choice>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
     <xs:attributeGroup ref="ns:TransactionType"/>
   </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"/>
 
 <xs:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="TransactionType">
   <xs:attribute use="required" name="ResponseType">
     <xs:simpleType>
       <!-- Reference to inner class Response -->
     </xs:simpleType>
   </xs:attribute>
 </xs:attributeGroup>
 

Nested Class Summary

static class	AvailRS.Fares Provides full details on the fares that are offered, along with the routes that are valid for each specific fare.
static class	AvailRS.OriginDestinationOptions Provides full details about availability between certain locations, including times, services, etc.
static class	AvailRS.Response Schema fragment(s) for this class:

Constructor Summary

AvailRS()

Method Summary

void	clearChoiceSelect() Clear the choice selection.
Errors	getErrors() Get the 'Errors' element value.
AvailRS.Fares	getFares() Get the 'Fares' element value.
AvailRS.OriginDestinationOptions	getOriginDestinationOptions() Get the 'OriginDestinationOptions' element value.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
AvailRS.Response	getResponse() Get the 'ResponseType' attribute value.
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	setErrors(Errors errors) Set the 'Errors' element value.
void	setFares(AvailRS.Fares fares) Set the 'Fares' element value.
void	setOriginDestinationOptions(AvailRS.OriginDestinationOptions originDestinationOptions) Set the 'OriginDestinationOptions' element value.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setResponse(AvailRS.Response response) Set the 'ResponseType' attribute value.
void	setWarnings(Warnings warnings) Set the 'Warnings' element value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailRS

public AvailRS()

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 -

getOriginDestinationOptions

public AvailRS.OriginDestinationOptions getOriginDestinationOptions()

Get the 'OriginDestinationOptions' element value.

Returns:

value

setOriginDestinationOptions

public void setOriginDestinationOptions(AvailRS.OriginDestinationOptions originDestinationOptions)

Set the 'OriginDestinationOptions' element value.

Parameters:

originDestinationOptions -

getFares

public AvailRS.Fares getFares()

Get the 'Fares' element value.

Returns:

value

setFares

public void setFares(AvailRS.Fares fares)

Set the 'Fares' element value.

Parameters:

fares -

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 -

getResponse

public AvailRS.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(AvailRS.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 -