org.ota.air
Class Fare

java.lang.Object
  extended by org.ota.air.Fare
Direct Known Subclasses:
AirItineraryPricingInfo.ItinTotalFare, PTCFareBreakdown.PassengerFare

public class Fare
extends java.lang.Object

Holds a base fare, tax, total and currency information on a price 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="FareType">
   <xs:sequence>
     <xs:element name="BaseFare" minOccurs="0">
       <!-- Reference to inner class BaseFare -->
     </xs:element>
     <xs:element name="EquivFare" minOccurs="0" maxOccurs="9">
       <!-- Reference to inner class EquivFare -->
     </xs:element>
     <xs:element name="Taxes" minOccurs="0">
       <!-- Reference to inner class Taxes -->
     </xs:element>
     <xs:element name="Fees" minOccurs="0">
       <!-- Reference to inner class Fees -->
     </xs:element>
     <xs:element name="TotalFare" minOccurs="0">
       <!-- Reference to inner class TotalFare -->
     </xs:element>
     <xs:element name="FareConstruction" minOccurs="0">
       <!-- Reference to inner class FareConstruction -->
     </xs:element>
     <xs:element name="UnstructuredFareCalc" minOccurs="0">
       <!-- Reference to inner class UnstructuredFareCalc -->
     </xs:element>
     <xs:element name="FareBaggageAllowance" minOccurs="0" maxOccurs="99">
       <!-- Reference to inner class FareBaggageAllowance -->
     </xs:element>
     <xs:element name="TourCode" minOccurs="0">
       <!-- Reference to inner class TourCode -->
     </xs:element>
     <xs:element type="xs:string" name="Remark" minOccurs="0" maxOccurs="10"/>
     <xs:element name="OriginalIssueInfo" minOccurs="0">
       <!-- Reference to inner class OriginalIssueInfo -->
     </xs:element>
     <xs:element name="ExchangeInfo" minOccurs="0">
       <!-- Reference to inner class ExchangeInfo -->
     </xs:element>
     <xs:element name="Discounts" minOccurs="0">
       <!-- Reference to inner class Discounts -->
     </xs:element>
     <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
   </xs:sequence>
   <xs:attributeGroup ref="ns:NegotiatedFareAttributes"/>
   <xs:attribute type="xs:string" use="optional" name="TicketDesignatorCode"/>
   <xs:attribute type="xs:int" use="optional" name="TotalNbrTrips"/>
   <xs:attribute type="xs:int" use="optional" name="TotalNbrPTC"/>
 </xs:complexType>
 
 <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"/>
 


Nested Class Summary
static class Fare.BaseFare
          Price of the inventory excluding taxes and fees.
static class Fare.Discounts
          Collection for discounts.
static class Fare.EquivFare
          Price of the inventory excluding taxes and fees in the payable currency.
static class Fare.ExchangeInfo
          Exchange ticket/document information.
static class Fare.FareBaggageAllowance
          Checked baggage allowance for the fare.
static class Fare.FareConstruction
          Should not contain unstructured FareCalc data.
static class Fare.Fees
          This is a collection of Fees Schema fragment(s) for this class:
static class Fare.OriginalIssueInfo
          The original ticket/document issue information.
static class Fare.Taxes
          This is a collection of Taxes Schema fragment(s) for this class:
static class Fare.TotalFare
          The total price that the passenger would pay (includes fare, taxes, fees) Schema fragment(s) for this class:
static class Fare.TourCode
          The tour code associated with the fare.
static class Fare.UnstructuredFareCalc
          Contains the fare calc information for the stored fare for the passenger.
 
Constructor Summary
Fare()
           
 
Method Summary
 void addEquivFare(Fare.EquivFare item)
          Add a 'EquivFare' element item.
 void addFareBaggageAllowance(Fare.FareBaggageAllowance item)
          Add a 'FareBaggageAllowance' element item.
 void addRemark(java.lang.String item)
          Add a 'Remark' element item.
 void clearEquivFares()
          Remove all 'EquivFare' element items.
 void clearFareBaggageAllowances()
          Remove all 'FareBaggageAllowance' element items.
 void clearRemarks()
          Remove all 'Remark' element items.
 Fare.BaseFare getBaseFare()
          Get the 'BaseFare' element value.
 Fare.Discounts getDiscounts()
          Get the 'Discounts' element value.
 Fare.EquivFare getEquivFare(int index)
          Get 'EquivFare' element item by position.
 java.util.List<Fare.EquivFare> getEquivFares()
          Get the list of 'EquivFare' element items.
 Fare.ExchangeInfo getExchangeInfo()
          Get the 'ExchangeInfo' element value.
 Fare.FareBaggageAllowance getFareBaggageAllowance(int index)
          Get 'FareBaggageAllowance' element item by position.
 java.util.List<Fare.FareBaggageAllowance> getFareBaggageAllowances()
          Get the list of 'FareBaggageAllowance' element items.
 Fare.FareConstruction getFareConstruction()
          Get the 'FareConstruction' element value.
 Fare.Fees getFees()
          Get the 'Fees' element value.
 NegotiatedFareAttributes getNegotiatedFareAttributes()
          Get the 'NegotiatedFareAttributes' attributeGroup value.
 Fare.OriginalIssueInfo getOriginalIssueInfo()
          Get the 'OriginalIssueInfo' element value.
 java.lang.String getRemark(int index)
          Get 'Remark' element item by position.
 java.util.List<java.lang.String> getRemarks()
          Get the list of 'Remark' element items.
 Fare.Taxes getTaxes()
          Get the 'Taxes' element value.
 java.lang.String getTicketDesignatorCode()
          Get the 'TicketDesignatorCode' attribute value.
 Fare.TotalFare getTotalFare()
          Get the 'TotalFare' element value.
 java.lang.Integer getTotalNbrPTC()
          Get the 'TotalNbrPTC' attribute value.
 java.lang.Integer getTotalNbrTrips()
          Get the 'TotalNbrTrips' attribute value.
 Fare.TourCode getTourCode()
          Get the 'TourCode' element value.
 TPAExtensions getTPAExtensions()
          Get the 'TPA_Extensions' element value.
 Fare.UnstructuredFareCalc getUnstructuredFareCalc()
          Get the 'UnstructuredFareCalc' element value.
 void setBaseFare(Fare.BaseFare baseFare)
          Set the 'BaseFare' element value.
 void setDiscounts(Fare.Discounts discounts)
          Set the 'Discounts' element value.
 void setEquivFares(java.util.List<Fare.EquivFare> list)
          Set the list of 'EquivFare' element items.
 void setExchangeInfo(Fare.ExchangeInfo exchangeInfo)
          Set the 'ExchangeInfo' element value.
 void setFareBaggageAllowances(java.util.List<Fare.FareBaggageAllowance> list)
          Set the list of 'FareBaggageAllowance' element items.
 void setFareConstruction(Fare.FareConstruction fareConstruction)
          Set the 'FareConstruction' element value.
 void setFees(Fare.Fees fees)
          Set the 'Fees' element value.
 void setNegotiatedFareAttributes(NegotiatedFareAttributes negotiatedFareAttributes)
          Set the 'NegotiatedFareAttributes' attributeGroup value.
 void setOriginalIssueInfo(Fare.OriginalIssueInfo originalIssueInfo)
          Set the 'OriginalIssueInfo' element value.
 void setRemarks(java.util.List<java.lang.String> list)
          Set the list of 'Remark' element items.
 void setTaxes(Fare.Taxes taxes)
          Set the 'Taxes' element value.
 void setTicketDesignatorCode(java.lang.String ticketDesignatorCode)
          Set the 'TicketDesignatorCode' attribute value.
 void setTotalFare(Fare.TotalFare totalFare)
          Set the 'TotalFare' element value.
 void setTotalNbrPTC(java.lang.Integer totalNbrPTC)
          Set the 'TotalNbrPTC' attribute value.
 void setTotalNbrTrips(java.lang.Integer totalNbrTrips)
          Set the 'TotalNbrTrips' attribute value.
 void setTourCode(Fare.TourCode tourCode)
          Set the 'TourCode' element value.
 void setTPAExtensions(TPAExtensions TPAExtensions)
          Set the 'TPA_Extensions' element value.
 void setUnstructuredFareCalc(Fare.UnstructuredFareCalc unstructuredFareCalc)
          Set the 'UnstructuredFareCalc' element value.
 int sizeEquivFares()
          Get the number of 'EquivFare' element items.
 int sizeFareBaggageAllowances()
          Get the number of 'FareBaggageAllowance' element items.
 int sizeRemarks()
          Get the number of 'Remark' element items.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Fare

public Fare()
Method Detail

getBaseFare

public Fare.BaseFare getBaseFare()
Get the 'BaseFare' element value.

Returns:
value

setBaseFare

public void setBaseFare(Fare.BaseFare baseFare)
Set the 'BaseFare' element value.

Parameters:
baseFare -

getEquivFares

public java.util.List<Fare.EquivFare> getEquivFares()
Get the list of 'EquivFare' element items.

Returns:
list

setEquivFares

public void setEquivFares(java.util.List<Fare.EquivFare> list)
Set the list of 'EquivFare' element items.

Parameters:
list -

sizeEquivFares

public int sizeEquivFares()
Get the number of 'EquivFare' element items.

Returns:
count

addEquivFare

public void addEquivFare(Fare.EquivFare item)
Add a 'EquivFare' element item.

Parameters:
item -

getEquivFare

public Fare.EquivFare getEquivFare(int index)
Get 'EquivFare' element item by position.

Parameters:
index -
Returns:
item

clearEquivFares

public void clearEquivFares()
Remove all 'EquivFare' element items.


getTaxes

public Fare.Taxes getTaxes()
Get the 'Taxes' element value.

Returns:
value

setTaxes

public void setTaxes(Fare.Taxes taxes)
Set the 'Taxes' element value.

Parameters:
taxes -

getFees

public Fare.Fees getFees()
Get the 'Fees' element value.

Returns:
value

setFees

public void setFees(Fare.Fees fees)
Set the 'Fees' element value.

Parameters:
fees -

getTotalFare

public Fare.TotalFare getTotalFare()
Get the 'TotalFare' element value.

Returns:
value

setTotalFare

public void setTotalFare(Fare.TotalFare totalFare)
Set the 'TotalFare' element value.

Parameters:
totalFare -

getFareConstruction

public Fare.FareConstruction getFareConstruction()
Get the 'FareConstruction' element value.

Returns:
value

setFareConstruction

public void setFareConstruction(Fare.FareConstruction fareConstruction)
Set the 'FareConstruction' element value.

Parameters:
fareConstruction -

getUnstructuredFareCalc

public Fare.UnstructuredFareCalc getUnstructuredFareCalc()
Get the 'UnstructuredFareCalc' element value.

Returns:
value

setUnstructuredFareCalc

public void setUnstructuredFareCalc(Fare.UnstructuredFareCalc unstructuredFareCalc)
Set the 'UnstructuredFareCalc' element value.

Parameters:
unstructuredFareCalc -

getFareBaggageAllowances

public java.util.List<Fare.FareBaggageAllowance> getFareBaggageAllowances()
Get the list of 'FareBaggageAllowance' element items.

Returns:
list

setFareBaggageAllowances

public void setFareBaggageAllowances(java.util.List<Fare.FareBaggageAllowance> list)
Set the list of 'FareBaggageAllowance' element items.

Parameters:
list -

sizeFareBaggageAllowances

public int sizeFareBaggageAllowances()
Get the number of 'FareBaggageAllowance' element items.

Returns:
count

addFareBaggageAllowance

public void addFareBaggageAllowance(Fare.FareBaggageAllowance item)
Add a 'FareBaggageAllowance' element item.

Parameters:
item -

getFareBaggageAllowance

public Fare.FareBaggageAllowance getFareBaggageAllowance(int index)
Get 'FareBaggageAllowance' element item by position.

Parameters:
index -
Returns:
item

clearFareBaggageAllowances

public void clearFareBaggageAllowances()
Remove all 'FareBaggageAllowance' element items.


getTourCode

public Fare.TourCode getTourCode()
Get the 'TourCode' element value.

Returns:
value

setTourCode

public void setTourCode(Fare.TourCode tourCode)
Set the 'TourCode' element value.

Parameters:
tourCode -

getRemarks

public java.util.List<java.lang.String> getRemarks()
Get the list of 'Remark' element items. Free flow remarks for the fare breakdown.

Returns:
list

setRemarks

public void setRemarks(java.util.List<java.lang.String> list)
Set the list of 'Remark' element items. Free flow remarks for the fare breakdown.

Parameters:
list -

sizeRemarks

public int sizeRemarks()
Get the number of 'Remark' element items.

Returns:
count

addRemark

public void addRemark(java.lang.String item)
Add a 'Remark' element item.

Parameters:
item -

getRemark

public java.lang.String getRemark(int index)
Get 'Remark' element item by position.

Parameters:
index -
Returns:
item

clearRemarks

public void clearRemarks()
Remove all 'Remark' element items.


getOriginalIssueInfo

public Fare.OriginalIssueInfo getOriginalIssueInfo()
Get the 'OriginalIssueInfo' element value.

Returns:
value

setOriginalIssueInfo

public void setOriginalIssueInfo(Fare.OriginalIssueInfo originalIssueInfo)
Set the 'OriginalIssueInfo' element value.

Parameters:
originalIssueInfo -

getExchangeInfo

public Fare.ExchangeInfo getExchangeInfo()
Get the 'ExchangeInfo' element value.

Returns:
value

setExchangeInfo

public void setExchangeInfo(Fare.ExchangeInfo exchangeInfo)
Set the 'ExchangeInfo' element value.

Parameters:
exchangeInfo -

getDiscounts

public Fare.Discounts getDiscounts()
Get the 'Discounts' element value.

Returns:
value

setDiscounts

public void setDiscounts(Fare.Discounts discounts)
Set the 'Discounts' element value.

Parameters:
discounts -

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 -

getNegotiatedFareAttributes

public NegotiatedFareAttributes getNegotiatedFareAttributes()
Get the 'NegotiatedFareAttributes' attributeGroup value. Used to indicate a negotiated fare and, if so, the fare code.

Returns:
value

setNegotiatedFareAttributes

public void setNegotiatedFareAttributes(NegotiatedFareAttributes negotiatedFareAttributes)
Set the 'NegotiatedFareAttributes' attributeGroup value. Used to indicate a negotiated fare and, if so, the fare code.

Parameters:
negotiatedFareAttributes -

getTicketDesignatorCode

public java.lang.String getTicketDesignatorCode()
Get the 'TicketDesignatorCode' attribute value. Specifies a discount code applicable to the fare.

Returns:
value

setTicketDesignatorCode

public void setTicketDesignatorCode(java.lang.String ticketDesignatorCode)
Set the 'TicketDesignatorCode' attribute value. Specifies a discount code applicable to the fare.

Parameters:
ticketDesignatorCode -

getTotalNbrTrips

public java.lang.Integer getTotalNbrTrips()
Get the 'TotalNbrTrips' attribute value. The total number of trips in this itinerary.

Returns:
value

setTotalNbrTrips

public void setTotalNbrTrips(java.lang.Integer totalNbrTrips)
Set the 'TotalNbrTrips' attribute value. The total number of trips in this itinerary.

Parameters:
totalNbrTrips -

getTotalNbrPTC

public java.lang.Integer getTotalNbrPTC()
Get the 'TotalNbrPTC' attribute value. The total number of passenger type codes in this priced itinerary.

Returns:
value

setTotalNbrPTC

public void setTotalNbrPTC(java.lang.Integer totalNbrPTC)
Set the 'TotalNbrPTC' attribute value. The total number of passenger type codes in this priced itinerary.

Parameters:
totalNbrPTC -