org.ota.rail
Class BookRQ

java.lang.Object
  org.ota.rail.BookRQ

public class BookRQ
extends java.lang.Object

The Book Request message is used to request that a reservation be created for one or more journies between specified locations on specific date(s) for a specific number and type of passengers. 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_RailBookRQ">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:POS_Type" name="POS" minOccurs="0"/>
       <xs:element name="RailBookInfo">
         <xs:complexType>
           <xs:sequence>
             <xs:element name="OriginDestinationOptions">
               <xs:complexType>
                 <xs:sequence>
                   <xs:element name="OriginDestinationOption" maxOccurs="99">
                     <!-- Reference to inner class OriginDestinationOption -->
                   </xs:element>
                 </xs:sequence>
               </xs:complexType>
             </xs:element>
             <xs:choice>
               <xs:element name="TravelerNames">
                 <xs:complexType>
                   <xs:sequence>
                     <xs:element type="ns:PersonNameType" name="TravelerName" maxOccurs="99"/>
                   </xs:sequence>
                 </xs:complexType>
               </xs:element>
               <xs:element name="TravelerCount" maxOccurs="5">
                 <xs:complexType>
                   <xs:attributeGroup ref="ns:TravelerCountGroup"/>
                 </xs:complexType>
               </xs:element>
             </xs:choice>
             <xs:element name="RateQualifier" minOccurs="0">
               <xs:complexType>
                 <xs:attributeGroup ref="ns:RateQualifierCoreGroup"/>
               </xs:complexType>
             </xs:element>
             <xs:element name="Fulfillment" minOccurs="0">
               <!-- Reference to inner class Fulfillment -->
             </xs:element>
             <xs:element type="ns:PaymentFormType" name="PaymentForm" minOccurs="0" maxOccurs="5"/>
           </xs:sequence>
         </xs:complexType>
       </xs:element>
     </xs:sequence>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
   </xs:complexType>
 </xs:element>
 

Nested Class Summary

static class	BookRQ.Fulfillment Information on the fullfilment of the ticket, that is, who will be issuing the ticket.
static class	BookRQ.OriginDestinationOption Details aboout one specific jouney between this origin and destination location.

Constructor Summary

BookRQ()

Method Summary

void	addOriginDestinationOption(BookRQ.OriginDestinationOption item) Add a 'OriginDestinationOption' element item.
void	addRailBookInfoPaymentForm(PaymentForm item) Add a 'PaymentForm' element item.
void	addRailBookInfoTravelerCount(TravelerCountGroup item) Add a 'TravelerCount' element item.
void	addRailBookInfoTravelerName(PersonName item) Add a 'TravelerName' element item.
void	clearOriginDestinationOptions() Remove all 'OriginDestinationOption' element items.
void	clearRailBookInfoChoiceSelect() Clear the choice selection.
void	clearRailBookInfoPaymentForms() Remove all 'PaymentForm' element items.
void	clearRailBookInfoTravelerCounts() Remove all 'TravelerCount' element items.
void	clearRailBookInfoTravelerNames() Remove all 'TravelerName' element items.
BookRQ.Fulfillment	getFulfillment() Get the 'Fulfillment' element value.
BookRQ.OriginDestinationOption	getOriginDestinationOption(int index) Get 'OriginDestinationOption' element item by position.
java.util.List<BookRQ.OriginDestinationOption>	getOriginDestinationOptions() Get the list of 'OriginDestinationOption' element items.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
POS	getPOS() Get the 'POS' element value.
PaymentForm	getRailBookInfoPaymentForm(int index) Get 'PaymentForm' element item by position.
java.util.List<PaymentForm>	getRailBookInfoPaymentForms() Get the list of 'PaymentForm' element items.
RateQualifierCoreGroup	getRailBookInfoRateQualifier() Get the 'RateQualifierCoreGroup' attributeGroup value.
TravelerCountGroup	getRailBookInfoTravelerCount(int index) Get 'TravelerCount' element item by position.
java.util.List<TravelerCountGroup>	getRailBookInfoTravelerCounts() Get the list of 'TravelerCount' element items.
PersonName	getRailBookInfoTravelerName(int index) Get 'TravelerName' element item by position.
java.util.List<PersonName>	getRailBookInfoTravelerNames() Get the list of 'TravelerName' element items.
boolean	ifRailBookInfoTravelerCount() Check if RailBookInfoTravelerCounts is current selection for choice.
boolean	ifRailBookInfoTravelerNames() Check if RailBookInfoTravelerNames is current selection for choice.
void	setFulfillment(BookRQ.Fulfillment fulfillment) Set the 'Fulfillment' element value.
void	setOriginDestinationOptions(java.util.List<BookRQ.OriginDestinationOption> list) Set the list of 'OriginDestinationOption' element items.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setPOS(POS POS) Set the 'POS' element value.
void	setRailBookInfoPaymentForms(java.util.List<PaymentForm> list) Set the list of 'PaymentForm' element items.
void	setRailBookInfoRateQualifier(RateQualifierCoreGroup railBookInfoRateQualifier) Set the 'RateQualifierCoreGroup' attributeGroup value.
void	setRailBookInfoTravelerCounts(java.util.List<TravelerCountGroup> list) Set the list of 'TravelerCount' element items.
void	setRailBookInfoTravelerNames(java.util.List<PersonName> list) Set the list of 'TravelerName' element items.
int	sizeOriginDestinationOptions() Get the number of 'OriginDestinationOption' element items.
int	sizeRailBookInfoPaymentForms() Get the number of 'PaymentForm' element items.
int	sizeRailBookInfoTravelerCounts() Get the number of 'TravelerCount' element items.
int	sizeRailBookInfoTravelerNames() Get the number of 'TravelerName' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

BookRQ

public BookRQ()

Method Detail

getPOS

public POS getPOS()

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

Parameters:

POS -

getOriginDestinationOptions

public java.util.List<BookRQ.OriginDestinationOption> getOriginDestinationOptions()

Get the list of 'OriginDestinationOption' element items. A collection of origin to destination journies that are to be included in the reservation.

Returns:

list

setOriginDestinationOptions

public void setOriginDestinationOptions(java.util.List<BookRQ.OriginDestinationOption> list)

Set the list of 'OriginDestinationOption' element items. A collection of origin to destination journies that are to be included in the reservation.

Parameters:

list -

sizeOriginDestinationOptions

public int sizeOriginDestinationOptions()

Get the number of 'OriginDestinationOption' element items.

Returns:

count

addOriginDestinationOption

public void addOriginDestinationOption(BookRQ.OriginDestinationOption item)

Add a 'OriginDestinationOption' element item.

Parameters:

item -

getOriginDestinationOption

public BookRQ.OriginDestinationOption getOriginDestinationOption(int index)

Get 'OriginDestinationOption' element item by position.

Parameters:

index -

Returns:

item

clearOriginDestinationOptions

public void clearOriginDestinationOptions()

Remove all 'OriginDestinationOption' element items.

clearRailBookInfoChoiceSelect

public void clearRailBookInfoChoiceSelect()

Clear the choice selection.

ifRailBookInfoTravelerNames

public boolean ifRailBookInfoTravelerNames()

Check if RailBookInfoTravelerNames is current selection for choice.

Returns:

true if selection, false if not

getRailBookInfoTravelerNames

public java.util.List<PersonName> getRailBookInfoTravelerNames()

Get the list of 'TravelerName' element items. A collection of traveler names to be included in the reservation.

Returns:

list

setRailBookInfoTravelerNames

public void setRailBookInfoTravelerNames(java.util.List<PersonName> list)

Set the list of 'TravelerName' element items. A collection of traveler names to be included in the reservation.

Parameters:

list -

sizeRailBookInfoTravelerNames

public int sizeRailBookInfoTravelerNames()

Get the number of 'TravelerName' element items.

Returns:

count

addRailBookInfoTravelerName

public void addRailBookInfoTravelerName(PersonName item)

Add a 'TravelerName' element item.

Parameters:

item -

getRailBookInfoTravelerName

public PersonName getRailBookInfoTravelerName(int index)

Get 'TravelerName' element item by position.

Parameters:

index -

Returns:

item

clearRailBookInfoTravelerNames

public void clearRailBookInfoTravelerNames()

Remove all 'TravelerName' element items.

ifRailBookInfoTravelerCount

public boolean ifRailBookInfoTravelerCount()

Check if RailBookInfoTravelerCounts is current selection for choice.

Returns:

true if selection, false if not

getRailBookInfoTravelerCounts

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

Get the list of 'TravelerCount' element items. Information on one specific traveler type and the quantity of that type of traveler.

Returns:

list

setRailBookInfoTravelerCounts

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

Set the list of 'TravelerCount' element items. Information on one specific traveler type and the quantity of that type of traveler.

Parameters:

list -

sizeRailBookInfoTravelerCounts

public int sizeRailBookInfoTravelerCounts()

Get the number of 'TravelerCount' element items.

Returns:

count

addRailBookInfoTravelerCount

public void addRailBookInfoTravelerCount(TravelerCountGroup item)

Add a 'TravelerCount' element item.

Parameters:

item -

getRailBookInfoTravelerCount

public TravelerCountGroup getRailBookInfoTravelerCount(int index)

Get 'TravelerCount' element item by position.

Parameters:

index -

Returns:

item

clearRailBookInfoTravelerCounts

public void clearRailBookInfoTravelerCounts()

Remove all 'TravelerCount' element items.

getRailBookInfoRateQualifier

public RateQualifierCoreGroup getRailBookInfoRateQualifier()

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

setRailBookInfoRateQualifier

public void setRailBookInfoRateQualifier(RateQualifierCoreGroup railBookInfoRateQualifier)

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:

railBookInfoRateQualifier -

getFulfillment

public BookRQ.Fulfillment getFulfillment()

Get the 'Fulfillment' element value. Full details on the reservation that is to be created, specifying location information, passenger data and opayment details.

Returns:

value

setFulfillment

public void setFulfillment(BookRQ.Fulfillment fulfillment)

Set the 'Fulfillment' element value. Full details on the reservation that is to be created, specifying location information, passenger data and opayment details.

Parameters:

fulfillment -

getRailBookInfoPaymentForms

public java.util.List<PaymentForm> getRailBookInfoPaymentForms()

Get the list of 'PaymentForm' element items. Information of the form(s) of payment to be used to pay for this reservation. The element repeats to allow for multiple forms of payment to be used, if so required.

Returns:

list

setRailBookInfoPaymentForms

public void setRailBookInfoPaymentForms(java.util.List<PaymentForm> list)

Set the list of 'PaymentForm' element items. Information of the form(s) of payment to be used to pay for this reservation. The element repeats to allow for multiple forms of payment to be used, if so required.

Parameters:

list -

sizeRailBookInfoPaymentForms

public int sizeRailBookInfoPaymentForms()

Get the number of 'PaymentForm' element items.

Returns:

count

addRailBookInfoPaymentForm

public void addRailBookInfoPaymentForm(PaymentForm item)

Add a 'PaymentForm' element item.

Parameters:

item -

getRailBookInfoPaymentForm

public PaymentForm getRailBookInfoPaymentForm(int index)

Get 'PaymentForm' element item by position.

Parameters:

index -

Returns:

item

clearRailBookInfoPaymentForms

public void clearRailBookInfoPaymentForms()

Remove all 'PaymentForm' element items.

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 -