org.ota.rail
Class RailFare

java.lang.Object
  org.ota.rail.RailFare

public class RailFare
extends java.lang.Object

Provides the information that fully describes a specific fare and its conditions of use. 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="RailFareType">
   <xs:sequence>
     <xs:element type="ns:JourneyType" name="Journey"/>
     <xs:element name="PassengerCounts">
       <xs:complexType>
         <xs:sequence>
           <xs:element name="PassengerCount" maxOccurs="5">
             <xs:complexType>
               <xs:attributeGroup ref="ns:TravelerCountGroup"/>
             </xs:complexType>
           </xs:element>
         </xs:sequence>
         <xs:attribute type="xs:int" name="TicketCount"/>
       </xs:complexType>
     </xs:element>
     <xs:choice>
       <xs:element name="FarePrices">
         <xs:complexType>
           <xs:sequence>
             <xs:element ref="ns:FareRuleType" maxOccurs="99"/>
           </xs:sequence>
         </xs:complexType>
       </xs:element>
       <xs:element name="MultiPassengerPrice">
         <xs:complexType>
           <xs:sequence>
             <xs:element ref="ns:TotalFare"/>
           </xs:sequence>
           <xs:attributeGroup ref="ns:CurrencyAmountGroup"/>
           <xs:attribute type="xs:boolean" use="optional" name="TooFewPassengers"/>
         </xs:complexType>
       </xs:element>
       <xs:element type="ns:NoFareReasonType" name="NoFareReason" minOccurs="0"/>
     </xs:choice>
     <xs:element name="PassengerLimits">
       <xs:complexType>
         <xs:attribute type="xs:string" name="MinPassengers"/>
         <xs:attribute type="xs:string" name="MaxPassengers"/>
         <xs:attribute type="xs:string" name="MinAdults"/>
         <xs:attribute type="xs:string" name="MaxAdults"/>
         <xs:attribute type="xs:string" name="MinChildren"/>
         <xs:attribute type="xs:string" name="MaxChildren"/>
       </xs:complexType>
     </xs:element>
     <xs:element name="FareClassification">
       <xs:complexType>
         <xs:attribute type="ns:CabinType" use="required" name="FareClass"/>
         <xs:attribute type="xs:string" use="required" name="FareGroup"/>
         <xs:attribute type="xs:string" use="required" name="SingleOrReturn"/>
         <xs:attribute type="xs:int" use="required" name="ValidityCode"/>
         <xs:attribute type="xs:int" use="optional" name="ReservationRequired"/>
         <xs:attribute type="xs:int" use="optional" name="RestrictionCode"/>
         <xs:attribute type="xs:int" use="optional" name="PackageMarker"/>
         <xs:attribute type="xs:string" name="DefaultCAPRI_Code"/>
         <xs:attribute type="xs:int" name="PublicationSequence"/>
       </xs:complexType>
     </xs:element>
     <xs:element name="Railcard" minOccurs="0">
       <!-- Reference to inner class Railcard -->
     </xs:element>
     <xs:element name="Bulletins" minOccurs="0">
       <!-- Reference to inner class Bulletins -->
     </xs:element>
   </xs:sequence>
   <xs:attribute type="xs:string" name="RPH"/>
   <xs:attribute type="xs:string" use="required" name="FareReference"/>
   <xs:attribute type="xs:string" use="required" name="TicketTypeCode"/>
   <xs:attribute type="xs:boolean" use="optional" name="AdvancePurchase"/>
   <xs:attribute type="xs:boolean" use="optional" name="TOC_Specific"/>
   <xs:attribute type="xs:boolean" use="optional" name="AlternativeFare"/>
   <xs:attribute type="xs:string" use="optional" name="CrossCityFareCode"/>
   <xs:attribute type="ns:CabinType" use="optional" name="Class"/>
 </xs:complexType>
 

Nested Class Summary

static class	RailFare.Bulletins A collection of references to bulletins that describe usage of this fare.
static class	RailFare.Railcard Encapsulates details of the railcard used in calculating the fare.

Constructor Summary

RailFare()

Method Summary

void	addFareRule(FareRule item) Add a 'FareRuleType' element item.
void	addPassengerCountsPassengerCount(TravelerCountGroup item) Add a 'PassengerCount' element item.
void	clearChoiceSelect() Clear the choice selection.
void	clearFareRules() Remove all 'FareRuleType' element items.
void	clearPassengerCountsPassengerCounts() Remove all 'PassengerCount' element items.
Cabin	get_Class() Get the 'Class' attribute value.
java.lang.Boolean	getAdvancePurchase() Get the 'AdvancePurchase' attribute value.
java.lang.Boolean	getAlternativeFare() Get the 'AlternativeFare' attribute value.
RailFare.Bulletins	getBulletins() Get the 'Bulletins' element value.
java.lang.String	getCrossCityFareCode() Get the 'CrossCityFareCode' attribute value.
java.lang.String	getFareClassificationDefaultCAPRICode() Get the 'DefaultCAPRI_Code' attribute value.
Cabin	getFareClassificationFareClass() Get the 'FareClass' attribute value.
java.lang.String	getFareClassificationFareGroup() Get the 'FareGroup' attribute value.
java.lang.Integer	getFareClassificationPackageMarker() Get the 'PackageMarker' attribute value.
java.lang.Integer	getFareClassificationPublicationSequence() Get the 'PublicationSequence' attribute value.
java.lang.Integer	getFareClassificationReservationRequired() Get the 'ReservationRequired' attribute value.
java.lang.Integer	getFareClassificationRestrictionCode() Get the 'RestrictionCode' attribute value.
java.lang.String	getFareClassificationSingleOrReturn() Get the 'SingleOrReturn' attribute value.
int	getFareClassificationValidityCode() Get the 'ValidityCode' attribute value.
java.lang.String	getFareReference() Get the 'FareReference' attribute value.
FareRule	getFareRule(int index) Get 'FareRuleType' element item by position.
java.util.List<FareRule>	getFareRules() Get the list of 'FareRuleType' element items.
Journey	getJourney() Get the 'Journey' element value.
CurrencyAmountGroup	getMultiPassengerPriceCurrencyAmountGroup() Get the 'CurrencyAmountGroup' attributeGroup value.
java.lang.Boolean	getMultiPassengerPriceTooFewPassengers() Get the 'TooFewPassengers' attribute value.
TotalFare	getMultiPassengerPriceTotalFare() Get the 'TotalFare' element value.
NoFareReason	getNoFareReason() Get the 'NoFareReason' element value.
TravelerCountGroup	getPassengerCountsPassengerCount(int index) Get 'PassengerCount' element item by position.
java.util.List<TravelerCountGroup>	getPassengerCountsPassengerCounts() Get the list of 'PassengerCount' element items.
java.lang.Integer	getPassengerCountsTicketCount() Get the 'TicketCount' attribute value.
java.lang.String	getPassengerLimitsMaxAdults() Get the 'MaxAdults' attribute value.
java.lang.String	getPassengerLimitsMaxChildren() Get the 'MaxChildren' attribute value.
java.lang.String	getPassengerLimitsMaxPassengers() Get the 'MaxPassengers' attribute value.
java.lang.String	getPassengerLimitsMinAdults() Get the 'MinAdults' attribute value.
java.lang.String	getPassengerLimitsMinChildren() Get the 'MinChildren' attribute value.
java.lang.String	getPassengerLimitsMinPassengers() Get the 'MinPassengers' attribute value.
RailFare.Railcard	getRailcard() Get the 'Railcard' element value.
java.lang.String	getRPH() Get the 'RPH' attribute value.
java.lang.String	getTicketTypeCode() Get the 'TicketTypeCode' attribute value.
java.lang.Boolean	getTOCSpecific() Get the 'TOC_Specific' attribute value.
boolean	ifFarePrices() Check if FarePrices is current selection for choice.
boolean	ifMultiPassengerPrice() Check if MultiPassengerPrice is current selection for choice.
boolean	ifNoFareReason() Check if NoFareReason is current selection for choice.
void	set_Class(Cabin _class) Set the 'Class' attribute value.
void	setAdvancePurchase(java.lang.Boolean advancePurchase) Set the 'AdvancePurchase' attribute value.
void	setAlternativeFare(java.lang.Boolean alternativeFare) Set the 'AlternativeFare' attribute value.
void	setBulletins(RailFare.Bulletins bulletins) Set the 'Bulletins' element value.
void	setCrossCityFareCode(java.lang.String crossCityFareCode) Set the 'CrossCityFareCode' attribute value.
void	setFareClassificationDefaultCAPRICode(java.lang.String fareClassificationDefaultCAPRICode) Set the 'DefaultCAPRI_Code' attribute value.
void	setFareClassificationFareClass(Cabin fareClassificationFareClass) Set the 'FareClass' attribute value.
void	setFareClassificationFareGroup(java.lang.String fareClassificationFareGroup) Set the 'FareGroup' attribute value.
void	setFareClassificationPackageMarker(java.lang.Integer fareClassificationPackageMarker) Set the 'PackageMarker' attribute value.
void	setFareClassificationPublicationSequence(java.lang.Integer fareClassificationPublicationSequence) Set the 'PublicationSequence' attribute value.
void	setFareClassificationReservationRequired(java.lang.Integer fareClassificationReservationRequired) Set the 'ReservationRequired' attribute value.
void	setFareClassificationRestrictionCode(java.lang.Integer fareClassificationRestrictionCode) Set the 'RestrictionCode' attribute value.
void	setFareClassificationSingleOrReturn(java.lang.String fareClassificationSingleOrReturn) Set the 'SingleOrReturn' attribute value.
void	setFareClassificationValidityCode(int fareClassificationValidityCode) Set the 'ValidityCode' attribute value.
void	setFareReference(java.lang.String fareReference) Set the 'FareReference' attribute value.
void	setFareRules(java.util.List<FareRule> list) Set the list of 'FareRuleType' element items.
void	setJourney(Journey journey) Set the 'Journey' element value.
void	setMultiPassengerPriceCurrencyAmountGroup(CurrencyAmountGroup multiPassengerPriceCurrencyAmountGroup) Set the 'CurrencyAmountGroup' attributeGroup value.
void	setMultiPassengerPriceTooFewPassengers(java.lang.Boolean multiPassengerPriceTooFewPassengers) Set the 'TooFewPassengers' attribute value.
void	setMultiPassengerPriceTotalFare(TotalFare multiPassengerPriceTotalFare) Set the 'TotalFare' element value.
void	setNoFareReason(NoFareReason noFareReason) Set the 'NoFareReason' element value.
void	setPassengerCountsPassengerCounts(java.util.List<TravelerCountGroup> list) Set the list of 'PassengerCount' element items.
void	setPassengerCountsTicketCount(java.lang.Integer passengerCountsTicketCount) Set the 'TicketCount' attribute value.
void	setPassengerLimitsMaxAdults(java.lang.String passengerLimitsMaxAdults) Set the 'MaxAdults' attribute value.
void	setPassengerLimitsMaxChildren(java.lang.String passengerLimitsMaxChildren) Set the 'MaxChildren' attribute value.
void	setPassengerLimitsMaxPassengers(java.lang.String passengerLimitsMaxPassengers) Set the 'MaxPassengers' attribute value.
void	setPassengerLimitsMinAdults(java.lang.String passengerLimitsMinAdults) Set the 'MinAdults' attribute value.
void	setPassengerLimitsMinChildren(java.lang.String passengerLimitsMinChildren) Set the 'MinChildren' attribute value.
void	setPassengerLimitsMinPassengers(java.lang.String passengerLimitsMinPassengers) Set the 'MinPassengers' attribute value.
void	setRailcard(RailFare.Railcard railcard) Set the 'Railcard' element value.
void	setRPH(java.lang.String RPH) Set the 'RPH' attribute value.
void	setTicketTypeCode(java.lang.String ticketTypeCode) Set the 'TicketTypeCode' attribute value.
void	setTOCSpecific(java.lang.Boolean TOCSpecific) Set the 'TOC_Specific' attribute value.
int	sizeFareRules() Get the number of 'FareRuleType' element items.
int	sizePassengerCountsPassengerCounts() Get the number of 'PassengerCount' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

RailFare

public RailFare()

Method Detail

getJourney

public Journey getJourney()

Get the 'Journey' element value. Information on the route on which this fare is offered.

Returns:

value

setJourney

public void setJourney(Journey journey)

Set the 'Journey' element value. Information on the route on which this fare is offered.

Parameters:

journey -

getPassengerCountsPassengerCounts

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

Get the list of 'PassengerCount' element items.

Returns:

list

setPassengerCountsPassengerCounts

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

Set the list of 'PassengerCount' element items.

Parameters:

list -

sizePassengerCountsPassengerCounts

public int sizePassengerCountsPassengerCounts()

Get the number of 'PassengerCount' element items.

Returns:

count

addPassengerCountsPassengerCount

public void addPassengerCountsPassengerCount(TravelerCountGroup item)

Add a 'PassengerCount' element item.

Parameters:

item -

getPassengerCountsPassengerCount

public TravelerCountGroup getPassengerCountsPassengerCount(int index)

Get 'PassengerCount' element item by position.

Parameters:

index -

Returns:

item

clearPassengerCountsPassengerCounts

public void clearPassengerCountsPassengerCounts()

Remove all 'PassengerCount' element items.

getPassengerCountsTicketCount

public java.lang.Integer getPassengerCountsTicketCount()

Get the 'TicketCount' attribute value. The physical number of tickets that will need to be purchased for a multi-passenger fare (i.e. if the 'MultiPassengerPrice' element is present). If the fare is not a multi-passenger fare (i.e. the 'MultiPassengerPrice' element is not present) then this value will be set to the sum of Adult and Child passenger counts.

Returns:

value

setPassengerCountsTicketCount

public void setPassengerCountsTicketCount(java.lang.Integer passengerCountsTicketCount)

Set the 'TicketCount' attribute value. The physical number of tickets that will need to be purchased for a multi-passenger fare (i.e. if the 'MultiPassengerPrice' element is present). If the fare is not a multi-passenger fare (i.e. the 'MultiPassengerPrice' element is not present) then this value will be set to the sum of Adult and Child passenger counts.

Parameters:

passengerCountsTicketCount -

clearChoiceSelect

public void clearChoiceSelect()

Clear the choice selection.

ifFarePrices

public boolean ifFarePrices()

Check if FarePrices is current selection for choice.

Returns:

true if selection, false if not

getFareRules

public java.util.List<FareRule> getFareRules()

Get the list of 'FareRuleType' element items. A collection of price details.

Returns:

list

setFareRules

public void setFareRules(java.util.List<FareRule> list)

Set the list of 'FareRuleType' element items. A collection of price details.

Parameters:

list -

sizeFareRules

public int sizeFareRules()

Get the number of 'FareRuleType' element items.

Returns:

count

addFareRule

public void addFareRule(FareRule item)

Add a 'FareRuleType' element item.

Parameters:

item -

getFareRule

public FareRule getFareRule(int index)

Get 'FareRuleType' element item by position.

Parameters:

index -

Returns:

item

clearFareRules

public void clearFareRules()

Remove all 'FareRuleType' element items.

ifMultiPassengerPrice

public boolean ifMultiPassengerPrice()

Check if MultiPassengerPrice is current selection for choice.

Returns:

true if selection, false if not

getMultiPassengerPriceTotalFare

public TotalFare getMultiPassengerPriceTotalFare()

Get the 'TotalFare' element value.

Returns:

value

setMultiPassengerPriceTotalFare

public void setMultiPassengerPriceTotalFare(TotalFare multiPassengerPriceTotalFare)

Set the 'TotalFare' element value.

Parameters:

multiPassengerPriceTotalFare -

getMultiPassengerPriceCurrencyAmountGroup

public CurrencyAmountGroup getMultiPassengerPriceCurrencyAmountGroup()

Get the 'CurrencyAmountGroup' attributeGroup value.

Returns:

value

setMultiPassengerPriceCurrencyAmountGroup

public void setMultiPassengerPriceCurrencyAmountGroup(CurrencyAmountGroup multiPassengerPriceCurrencyAmountGroup)

Set the 'CurrencyAmountGroup' attributeGroup value.

Parameters:

multiPassengerPriceCurrencyAmountGroup -

getMultiPassengerPriceTooFewPassengers

public java.lang.Boolean getMultiPassengerPriceTooFewPassengers()

Get the 'TooFewPassengers' attribute value. Indicates whether the composition of the passengers meets the maximum and minimum requirements of a multi-passenger ticket. For example, if only 2 adults are travelling on a ticket that requires at least one child to also be travelling. When true, there are too few passengers for the number of tickets returned in 'TicketCount'. When false, the minimum and maximum requirements to the Ticket have been satisfied for the number of tickets returned in 'TicketCount'. This parameter has a default value of false and will only be present if the value is set to true.

Returns:

value

setMultiPassengerPriceTooFewPassengers

public void setMultiPassengerPriceTooFewPassengers(java.lang.Boolean multiPassengerPriceTooFewPassengers)

Set the 'TooFewPassengers' attribute value. Indicates whether the composition of the passengers meets the maximum and minimum requirements of a multi-passenger ticket. For example, if only 2 adults are travelling on a ticket that requires at least one child to also be travelling. When true, there are too few passengers for the number of tickets returned in 'TicketCount'. When false, the minimum and maximum requirements to the Ticket have been satisfied for the number of tickets returned in 'TicketCount'. This parameter has a default value of false and will only be present if the value is set to true.

Parameters:

multiPassengerPriceTooFewPassengers -

ifNoFareReason

public boolean ifNoFareReason()

Check if NoFareReason is current selection for choice.

Returns:

true if selection, false if not

getNoFareReason

public NoFareReason getNoFareReason()

Get the 'NoFareReason' element value. Encapsulates the reason code and text that provide details of why the price of a fare could not be calculated

Returns:

value

setNoFareReason

public void setNoFareReason(NoFareReason noFareReason)

Set the 'NoFareReason' element value. Encapsulates the reason code and text that provide details of why the price of a fare could not be calculated

Parameters:

noFareReason -

getPassengerLimitsMinPassengers

public java.lang.String getPassengerLimitsMinPassengers()

Get the 'MinPassengers' attribute value. The minimum number of passengers for this ticket.

Returns:

value

setPassengerLimitsMinPassengers

public void setPassengerLimitsMinPassengers(java.lang.String passengerLimitsMinPassengers)

Set the 'MinPassengers' attribute value. The minimum number of passengers for this ticket.

Parameters:

passengerLimitsMinPassengers -

getPassengerLimitsMaxPassengers

public java.lang.String getPassengerLimitsMaxPassengers()

Get the 'MaxPassengers' attribute value. The maximum number of passengers for this ticket.

Returns:

value

setPassengerLimitsMaxPassengers

public void setPassengerLimitsMaxPassengers(java.lang.String passengerLimitsMaxPassengers)

Set the 'MaxPassengers' attribute value. The maximum number of passengers for this ticket.

Parameters:

passengerLimitsMaxPassengers -

getPassengerLimitsMinAdults

public java.lang.String getPassengerLimitsMinAdults()

Get the 'MinAdults' attribute value. The minimum number of adults for this ticket.

Returns:

value

setPassengerLimitsMinAdults

public void setPassengerLimitsMinAdults(java.lang.String passengerLimitsMinAdults)

Set the 'MinAdults' attribute value. The minimum number of adults for this ticket.

Parameters:

passengerLimitsMinAdults -

getPassengerLimitsMaxAdults

public java.lang.String getPassengerLimitsMaxAdults()

Get the 'MaxAdults' attribute value. The maximum number of adults for this ticket.

Returns:

value

setPassengerLimitsMaxAdults

public void setPassengerLimitsMaxAdults(java.lang.String passengerLimitsMaxAdults)

Set the 'MaxAdults' attribute value. The maximum number of adults for this ticket.

Parameters:

passengerLimitsMaxAdults -

getPassengerLimitsMinChildren

public java.lang.String getPassengerLimitsMinChildren()

Get the 'MinChildren' attribute value. The minimum number of children for this ticket.

Returns:

value

setPassengerLimitsMinChildren

public void setPassengerLimitsMinChildren(java.lang.String passengerLimitsMinChildren)

Set the 'MinChildren' attribute value. The minimum number of children for this ticket.

Parameters:

passengerLimitsMinChildren -

getPassengerLimitsMaxChildren

public java.lang.String getPassengerLimitsMaxChildren()

Get the 'MaxChildren' attribute value. The maximum number of children for this ticket.

Returns:

value

setPassengerLimitsMaxChildren

public void setPassengerLimitsMaxChildren(java.lang.String passengerLimitsMaxChildren)

Set the 'MaxChildren' attribute value. The maximum number of children for this ticket.

Parameters:

passengerLimitsMaxChildren -

getFareClassificationFareClass

public Cabin getFareClassificationFareClass()

Get the 'FareClass' attribute value. The class of the ticket: '1'= First class; '2'= Standard class; '9'= Other.

Returns:

value

setFareClassificationFareClass

public void setFareClassificationFareClass(Cabin fareClassificationFareClass)

Set the 'FareClass' attribute value. The class of the ticket: '1'= First class; '2'= Standard class; '9'= Other.

Parameters:

fareClassificationFareClass -

getFareClassificationFareGroup

public java.lang.String getFareClassificationFareGroup()

Get the 'FareGroup' attribute value. A 1-character code indicating the fare group. 'F'= First; 'S'= Standard; 'P'= Promotional; 'E'= Euro

Returns:

value

setFareClassificationFareGroup

public void setFareClassificationFareGroup(java.lang.String fareClassificationFareGroup)

Set the 'FareGroup' attribute value. A 1-character code indicating the fare group. 'F'= First; 'S'= Standard; 'P'= Promotional; 'E'= Euro

Parameters:

fareClassificationFareGroup -

getFareClassificationSingleOrReturn

public java.lang.String getFareClassificationSingleOrReturn()

Get the 'SingleOrReturn' attribute value. A 1-character code indicating whether the ticket is a single or return. 'S'= Single; 'R'= Return;

Returns:

value

setFareClassificationSingleOrReturn

public void setFareClassificationSingleOrReturn(java.lang.String fareClassificationSingleOrReturn)

Set the 'SingleOrReturn' attribute value. A 1-character code indicating whether the ticket is a single or return. 'S'= Single; 'R'= Return;

Parameters:

fareClassificationSingleOrReturn -

getFareClassificationValidityCode

public int getFareClassificationValidityCode()

Get the 'ValidityCode' attribute value. FACETS ticket validity reference.

Returns:

value

setFareClassificationValidityCode

public void setFareClassificationValidityCode(int fareClassificationValidityCode)

Set the 'ValidityCode' attribute value. FACETS ticket validity reference.

Parameters:

fareClassificationValidityCode -

getFareClassificationReservationRequired

public java.lang.Integer getFareClassificationReservationRequired()

Get the 'ReservationRequired' attribute value. Indicates if a reservation is required for this fare, and if so the direction of travel for which it is necessary. '1'= for the outward travel direction; '2'= for the return travel direction; '3'= for the both travel directions. If reservations are not required for the fare, this element will not be present.

Returns:

value

setFareClassificationReservationRequired

public void setFareClassificationReservationRequired(java.lang.Integer fareClassificationReservationRequired)

Set the 'ReservationRequired' attribute value. Indicates if a reservation is required for this fare, and if so the direction of travel for which it is necessary. '1'= for the outward travel direction; '2'= for the return travel direction; '3'= for the both travel directions. If reservations are not required for the fare, this element will not be present.

Parameters:

fareClassificationReservationRequired -

getFareClassificationRestrictionCode

public java.lang.Integer getFareClassificationRestrictionCode()

Get the 'RestrictionCode' attribute value. The restriction code of the Fare.

Returns:

value

setFareClassificationRestrictionCode

public void setFareClassificationRestrictionCode(java.lang.Integer fareClassificationRestrictionCode)

Set the 'RestrictionCode' attribute value. The restriction code of the Fare.

Parameters:

fareClassificationRestrictionCode -

getFareClassificationPackageMarker

public java.lang.Integer getFareClassificationPackageMarker()

Get the 'PackageMarker' attribute value. Indicate if this fare is a package and if so the type of package. '1'= Fare package; '2'= Fare and Supplement package; '3'= Supplement Package. If the fare is not a package, this attribute will not be present.

Returns:

value

setFareClassificationPackageMarker

public void setFareClassificationPackageMarker(java.lang.Integer fareClassificationPackageMarker)

Set the 'PackageMarker' attribute value. Indicate if this fare is a package and if so the type of package. '1'= Fare package; '2'= Fare and Supplement package; '3'= Supplement Package. If the fare is not a package, this attribute will not be present.

Parameters:

fareClassificationPackageMarker -

getFareClassificationDefaultCAPRICode

public java.lang.String getFareClassificationDefaultCAPRICode()

Get the 'DefaultCAPRI_Code' attribute value. The 3 character CAPRI code of the fare

Returns:

value

setFareClassificationDefaultCAPRICode

public void setFareClassificationDefaultCAPRICode(java.lang.String fareClassificationDefaultCAPRICode)

Set the 'DefaultCAPRI_Code' attribute value. The 3 character CAPRI code of the fare

Parameters:

fareClassificationDefaultCAPRICode -

getFareClassificationPublicationSequence

public java.lang.Integer getFareClassificationPublicationSequence()

Get the 'PublicationSequence' attribute value. A 3 digit value indicating the order in which this ticket is published in the National Fares Manual.

Returns:

value

setFareClassificationPublicationSequence

public void setFareClassificationPublicationSequence(java.lang.Integer fareClassificationPublicationSequence)

Set the 'PublicationSequence' attribute value. A 3 digit value indicating the order in which this ticket is published in the National Fares Manual.

Parameters:

fareClassificationPublicationSequence -

getRailcard

public RailFare.Railcard getRailcard()

Get the 'Railcard' element value.

Returns:

value

setRailcard

public void setRailcard(RailFare.Railcard railcard)

Set the 'Railcard' element value.

Parameters:

railcard -

getBulletins

public RailFare.Bulletins getBulletins()

Get the 'Bulletins' element value.

Returns:

value

setBulletins

public void setBulletins(RailFare.Bulletins bulletins)

Set the 'Bulletins' element value.

Parameters:

bulletins -

getRPH

public java.lang.String getRPH()

Get the 'RPH' attribute value.

Returns:

value

setRPH

public void setRPH(java.lang.String RPH)

Set the 'RPH' attribute value.

Parameters:

RPH -

getFareReference

public java.lang.String getFareReference()

Get the 'FareReference' attribute value. A unique 5 digit reference for this fare within the fares returned.

Returns:

value

setFareReference

public void setFareReference(java.lang.String fareReference)

Set the 'FareReference' attribute value. A unique 5 digit reference for this fare within the fares returned.

Parameters:

fareReference -

getTicketTypeCode

public java.lang.String getTicketTypeCode()

Get the 'TicketTypeCode' attribute value. The 3 character ticket type code of the fare.

Returns:

value

setTicketTypeCode

public void setTicketTypeCode(java.lang.String ticketTypeCode)

Set the 'TicketTypeCode' attribute value. The 3 character ticket type code of the fare.

Parameters:

ticketTypeCode -

getAdvancePurchase

public java.lang.Boolean getAdvancePurchase()

Get the 'AdvancePurchase' attribute value. Indicates whether this is an Advance Purchase fare. 'TRUE'= Advance Purchase fare; 'FALSE'= Not an Advance Purchase fare. This parameter has a default value of 'FALSE'and will only be present if the value is set to 'TRUE’.

Returns:

value

setAdvancePurchase

public void setAdvancePurchase(java.lang.Boolean advancePurchase)

Set the 'AdvancePurchase' attribute value. Indicates whether this is an Advance Purchase fare. 'TRUE'= Advance Purchase fare; 'FALSE'= Not an Advance Purchase fare. This parameter has a default value of 'FALSE'and will only be present if the value is set to 'TRUE’.

Parameters:

advancePurchase -

getTOCSpecific

public java.lang.Boolean getTOCSpecific()

Get the 'TOC_Specific' attribute value. Indicates whether this is a TOC specific fare. 'TRUE'= TOC Specific fare; 'FALSE’= Not a TOC Specific fare. This parameter has a default value of 'FALSE'and will only be present if the value is set to 'TRUE’.

Returns:

value

setTOCSpecific

public void setTOCSpecific(java.lang.Boolean TOCSpecific)

Set the 'TOC_Specific' attribute value. Indicates whether this is a TOC specific fare. 'TRUE'= TOC Specific fare; 'FALSE’= Not a TOC Specific fare. This parameter has a default value of 'FALSE'and will only be present if the value is set to 'TRUE’.

Parameters:

TOCSpecific -

getAlternativeFare

public java.lang.Boolean getAlternativeFare()

Get the 'AlternativeFare' attribute value. Indicates whether the fare is from or to a location that differs from the non-fares group location used in the input criteria. 'TRUE’= The fare is from/to a different location; 'FALSE'= The fare is from/to the same location. This parameter has a default value of 'FALSE'and will only be present if the value is set to 'TRUE’.

Returns:

value

setAlternativeFare

public void setAlternativeFare(java.lang.Boolean alternativeFare)

Set the 'AlternativeFare' attribute value. Indicates whether the fare is from or to a location that differs from the non-fares group location used in the input criteria. 'TRUE’= The fare is from/to a different location; 'FALSE'= The fare is from/to the same location. This parameter has a default value of 'FALSE'and will only be present if the value is set to 'TRUE’.

Parameters:

alternativeFare -

getCrossCityFareCode

public java.lang.String getCrossCityFareCode()

Get the 'CrossCityFareCode' attribute value. The use of this attribute indicates a cross city fare. When used, its value will be a city code.

Returns:

value

setCrossCityFareCode

public void setCrossCityFareCode(java.lang.String crossCityFareCode)

Set the 'CrossCityFareCode' attribute value. The use of this attribute indicates a cross city fare. When used, its value will be a city code.

Parameters:

crossCityFareCode -

get_Class

public Cabin get_Class()

Get the 'Class' attribute value.

Returns:

value

set_Class

public void set_Class(Cabin _class)

Set the 'Class' attribute value.

Parameters:

_class -