org.ota.air
Class BookFlightSegment

java.lang.Object
  org.ota.shared.FlightSegmentBase
      org.ota.air.FlightSegment
          org.ota.air.BookFlightSegment

Direct Known Subclasses:

AirItinerary.OriginDestinationOption.FlightSegment, PTCFareBreakdown.PricingUnit.FareComponent.FlightLeg

public class BookFlightSegment
extends FlightSegment

Container for the flight segment data plus the MarriageGrp. Construct for holding the booked flight segment information. 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="BookFlightSegmentType">
   <xs:complexContent>
     <xs:extension base="ns:FlightSegmentType">
       <xs:sequence>
         <xs:element type="xs:string" name="MarriageGrp" minOccurs="0"/>
         <xs:element name="BookingClassAvails" minOccurs="0" maxOccurs="3">
           <!-- Reference to inner class BookingClassAvails -->
         </xs:element>
         <xs:element type="ns:FreeTextType" name="Comment" minOccurs="0" maxOccurs="9"/>
         <xs:element name="StopLocation" minOccurs="0" maxOccurs="9">
           <xs:complexType>
             <xs:attributeGroup ref="ns:LocationGroup"/>
           </xs:complexType>
         </xs:element>
       </xs:sequence>
       <xs:attribute type="xs:string" use="optional" name="ResBookDesigCode"/>
       <xs:attribute type="xs:string" use="optional" name="NumberInParty"/>
       <xs:attribute type="xs:string" use="optional" name="Status"/>
       <xs:attribute use="optional" name="E_TicketEligibility">
         <xs:simpleType>
           <!-- Reference to inner class ETicketEligibility -->
         </xs:simpleType>
       </xs:attribute>
       <xs:attribute type="xs:string" use="optional" name="MealCode"/>
       <xs:attribute type="ns:DayOfWeekType" use="optional" name="DepartureDay"/>
       <xs:attribute type="xs:boolean" use="optional" name="StopoverInd"/>
       <xs:attribute type="xs:int" use="optional" name="LineNumber"/>
       <xs:attribute type="xs:string" use="optional" name="ConnectionType"/>
       <xs:attribute type="xs:string" use="optional" name="ParticipationLevelCode"/>
       <xs:attribute type="xs:int" use="optional" name="Distance"/>
       <xs:attribute type="xs:string" use="optional" name="DateChangeNbr"/>
       <xs:attribute type="xs:boolean" use="optional" name="ValidConnectionInd"/>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>
 

Nested Class Summary

static class	BookFlightSegment.BookingClassAvails A collection of availability counts per booking class.
static class	BookFlightSegment.ETicketEligibility Schema fragment(s) for this class:

Nested classes/interfaces inherited from class org.ota.air.FlightSegment

FlightSegment.MarketingAirline

Constructor Summary

BookFlightSegment()

Method Summary

void	addBookingClassAvail(BookFlightSegment.BookingClassAvails item) Add a 'BookingClassAvails' element item.
void	addComment(FreeText item) Add a 'Comment' element item.
void	addStopLocation(LocationGroup item) Add a 'StopLocation' element item.
void	clearBookingClassAvails() Remove all 'BookingClassAvails' element items.
void	clearComments() Remove all 'Comment' element items.
void	clearStopLocations() Remove all 'StopLocation' element items.
BookFlightSegment.BookingClassAvails	getBookingClassAvail(int index) Get 'BookingClassAvails' element item by position.
java.util.List<BookFlightSegment.BookingClassAvails>	getBookingClassAvails() Get the list of 'BookingClassAvails' element items.
FreeText	getComment(int index) Get 'Comment' element item by position.
java.util.List<FreeText>	getComments() Get the list of 'Comment' element items.
java.lang.String	getConnection() Get the 'ConnectionType' attribute value.
java.lang.String	getDateChangeNbr() Get the 'DateChangeNbr' attribute value.
DayOfWeek	getDepartureDay() Get the 'DepartureDay' attribute value.
java.lang.Integer	getDistance() Get the 'Distance' attribute value.
BookFlightSegment.ETicketEligibility	getETicketEligibility1() Get the 'E_TicketEligibility' attribute value.
java.lang.Integer	getLineNumber() Get the 'LineNumber' attribute value.
java.lang.String	getMarriageGrp() Get the 'MarriageGrp' element value.
java.lang.String	getMealCode() Get the 'MealCode' attribute value.
java.lang.String	getNumberInParty() Get the 'NumberInParty' attribute value.
java.lang.String	getParticipationLevelCode() Get the 'ParticipationLevelCode' attribute value.
java.lang.String	getResBookDesigCode() Get the 'ResBookDesigCode' attribute value.
java.lang.String	getStatus() Get the 'Status' attribute value.
LocationGroup	getStopLocation(int index) Get 'StopLocation' element item by position.
java.util.List<LocationGroup>	getStopLocations() Get the list of 'StopLocation' element items.
java.lang.Boolean	getStopoverInd() Get the 'StopoverInd' attribute value.
java.lang.Boolean	getValidConnectionInd() Get the 'ValidConnectionInd' attribute value.
void	setBookingClassAvails(java.util.List<BookFlightSegment.BookingClassAvails> list) Set the list of 'BookingClassAvails' element items.
void	setComments(java.util.List<FreeText> list) Set the list of 'Comment' element items.
void	setConnection(java.lang.String connection) Set the 'ConnectionType' attribute value.
void	setDateChangeNbr(java.lang.String dateChangeNbr) Set the 'DateChangeNbr' attribute value.
void	setDepartureDay(DayOfWeek departureDay) Set the 'DepartureDay' attribute value.
void	setDistance(java.lang.Integer distance) Set the 'Distance' attribute value.
void	setETicketEligibility1(BookFlightSegment.ETicketEligibility ETicketEligibility1) Set the 'E_TicketEligibility' attribute value.
void	setLineNumber(java.lang.Integer lineNumber) Set the 'LineNumber' attribute value.
void	setMarriageGrp(java.lang.String marriageGrp) Set the 'MarriageGrp' element value.
void	setMealCode(java.lang.String mealCode) Set the 'MealCode' attribute value.
void	setNumberInParty(java.lang.String numberInParty) Set the 'NumberInParty' attribute value.
void	setParticipationLevelCode(java.lang.String participationLevelCode) Set the 'ParticipationLevelCode' attribute value.
void	setResBookDesigCode(java.lang.String resBookDesigCode) Set the 'ResBookDesigCode' attribute value.
void	setStatus(java.lang.String status) Set the 'Status' attribute value.
void	setStopLocations(java.util.List<LocationGroup> list) Set the list of 'StopLocation' element items.
void	setStopoverInd(java.lang.Boolean stopoverInd) Set the 'StopoverInd' attribute value.
void	setValidConnectionInd(java.lang.Boolean validConnectionInd) Set the 'ValidConnectionInd' attribute value.
int	sizeBookingClassAvails() Get the number of 'BookingClassAvails' element items.
int	sizeComments() Get the number of 'Comment' element items.
int	sizeStopLocations() Get the number of 'StopLocation' element items.

Methods inherited from class org.ota.air.FlightSegment

getFlightNumber, getMarketingAirline, getTourOperatorFlightID, setFlightNumber, setMarketingAirline, setTourOperatorFlightID

Methods inherited from class org.ota.shared.FlightSegmentBase

addEquipment, clearEquipments, getArrivalAirport, getArrivalDateTime, getDepartureAirport, getDepartureDateTime, getEquipment, getEquipments, getInfoSource, getOperatingAirline, getRPH, getStopQuantity, setArrivalAirport, setArrivalDateTime, setDepartureAirport, setDepartureDateTime, setEquipments, setInfoSource, setOperatingAirline, setRPH, setStopQuantity, sizeEquipments

Methods inherited from class java.lang.Object

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

Constructor Detail

BookFlightSegment

public BookFlightSegment()

Method Detail

getMarriageGrp

public java.lang.String getMarriageGrp()

Get the 'MarriageGrp' element value. Many airlines link connection flights together by terming them married segments. When two or more segments are married, they must be processed as one unit. The segments must be moved, cancelled, and/or priced together. The value of the marriage group must be the same for all segments.

Returns:

value

setMarriageGrp

public void setMarriageGrp(java.lang.String marriageGrp)

Set the 'MarriageGrp' element value. Many airlines link connection flights together by terming them married segments. When two or more segments are married, they must be processed as one unit. The segments must be moved, cancelled, and/or priced together. The value of the marriage group must be the same for all segments.

Parameters:

marriageGrp -

getBookingClassAvails

public java.util.List<BookFlightSegment.BookingClassAvails> getBookingClassAvails()

Get the list of 'BookingClassAvails' element items.

Returns:

list

setBookingClassAvails

public void setBookingClassAvails(java.util.List<BookFlightSegment.BookingClassAvails> list)

Set the list of 'BookingClassAvails' element items.

Parameters:

list -

sizeBookingClassAvails

public int sizeBookingClassAvails()

Get the number of 'BookingClassAvails' element items.

Returns:

count

addBookingClassAvail

public void addBookingClassAvail(BookFlightSegment.BookingClassAvails item)

Add a 'BookingClassAvails' element item.

Parameters:

item -

getBookingClassAvail

public BookFlightSegment.BookingClassAvails getBookingClassAvail(int index)

Get 'BookingClassAvails' element item by position.

Parameters:

index -

Returns:

item

clearBookingClassAvails

public void clearBookingClassAvails()

Remove all 'BookingClassAvails' element items.

getComments

public java.util.List<FreeText> getComments()

Get the list of 'Comment' element items. Free text information that the marketing carrier may send about this flight.

Returns:

list

setComments

public void setComments(java.util.List<FreeText> list)

Set the list of 'Comment' element items. Free text information that the marketing carrier may send about this flight.

Parameters:

list -

sizeComments

public int sizeComments()

Get the number of 'Comment' element items.

Returns:

count

addComment

public void addComment(FreeText item)

Add a 'Comment' element item.

Parameters:

item -

getComment

public FreeText getComment(int index)

Get 'Comment' element item by position.

Parameters:

index -

Returns:

item

clearComments

public void clearComments()

Remove all 'Comment' element items.

getStopLocations

public java.util.List<LocationGroup> getStopLocations()

Get the list of 'StopLocation' element items. A location where the flight is scheduled to stop en route to its destination for this flight segment.

Returns:

list

setStopLocations

public void setStopLocations(java.util.List<LocationGroup> list)

Set the list of 'StopLocation' element items. A location where the flight is scheduled to stop en route to its destination for this flight segment.

Parameters:

list -

sizeStopLocations

public int sizeStopLocations()

Get the number of 'StopLocation' element items.

Returns:

count

addStopLocation

public void addStopLocation(LocationGroup item)

Add a 'StopLocation' element item.

Parameters:

item -

getStopLocation

public LocationGroup getStopLocation(int index)

Get 'StopLocation' element item by position.

Parameters:

index -

Returns:

item

clearStopLocations

public void clearStopLocations()

Remove all 'StopLocation' element items.

getResBookDesigCode

public java.lang.String getResBookDesigCode()

Get the 'ResBookDesigCode' attribute value. Specific Booking Class for this segment.

Returns:

value

setResBookDesigCode

public void setResBookDesigCode(java.lang.String resBookDesigCode)

Set the 'ResBookDesigCode' attribute value. Specific Booking Class for this segment.

Parameters:

resBookDesigCode -

getNumberInParty

public java.lang.String getNumberInParty()

Get the 'NumberInParty' attribute value. Number of travelers associated with this segment.

Returns:

value

setNumberInParty

public void setNumberInParty(java.lang.String numberInParty)

Set the 'NumberInParty' attribute value. Number of travelers associated with this segment.

Parameters:

numberInParty -

getStatus

public java.lang.String getStatus()

Get the 'Status' attribute value. Code providing status information for this segment. Refer to OpenTravel Code List 'Status' (STS).

Returns:

value

setStatus

public void setStatus(java.lang.String status)

Set the 'Status' attribute value. Code providing status information for this segment. Refer to OpenTravel Code List 'Status' (STS).

Parameters:

status -

getETicketEligibility1

public BookFlightSegment.ETicketEligibility getETicketEligibility1()

Get the 'E_TicketEligibility' attribute value. Specifies whether a flight segment is eligible for electronic ticketing.

Returns:

value

setETicketEligibility1

public void setETicketEligibility1(BookFlightSegment.ETicketEligibility ETicketEligibility1)

Set the 'E_TicketEligibility' attribute value. Specifies whether a flight segment is eligible for electronic ticketing.

Parameters:

ETicketEligibility1 -

getMealCode

public java.lang.String getMealCode()

Get the 'MealCode' attribute value. The applicable meal service code for this flight.

Returns:

value

setMealCode

public void setMealCode(java.lang.String mealCode)

Set the 'MealCode' attribute value. The applicable meal service code for this flight.

Parameters:

mealCode -

getDepartureDay

public DayOfWeek getDepartureDay()

Get the 'DepartureDay' attribute value.

Returns:

value

setDepartureDay

public void setDepartureDay(DayOfWeek departureDay)

Set the 'DepartureDay' attribute value.

Parameters:

departureDay -

getStopoverInd

public java.lang.Boolean getStopoverInd()

Get the 'StopoverInd' attribute value. When true a stopover is permitted (airline display "O"). When false a stopover is not permitted (airline display "X").

Returns:

value

setStopoverInd

public void setStopoverInd(java.lang.Boolean stopoverInd)

Set the 'StopoverInd' attribute value. When true a stopover is permitted (airline display "O"). When false a stopover is not permitted (airline display "X").

Parameters:

stopoverInd -

getLineNumber

public java.lang.Integer getLineNumber()

Get the 'LineNumber' attribute value. A number that corresponds to a line in a previous response of flight segments.

Returns:

value

setLineNumber

public void setLineNumber(java.lang.Integer lineNumber)

Set the 'LineNumber' attribute value. A number that corresponds to a line in a previous response of flight segments.

Parameters:

lineNumber -

getConnection

public java.lang.String getConnection()

Get the 'ConnectionType' attribute value. Used to provide the type of connection for this flight segment.

Returns:

value

setConnection

public void setConnection(java.lang.String connection)

Set the 'ConnectionType' attribute value. Used to provide the type of connection for this flight segment.

Parameters:

connection -

getParticipationLevelCode

public java.lang.String getParticipationLevelCode()

Get the 'ParticipationLevelCode' attribute value. To specify the level of participation by a vendor in another system. Refer to OpenTravel Code List 'Participation Level Code' (PLC).

Returns:

value

setParticipationLevelCode

public void setParticipationLevelCode(java.lang.String participationLevelCode)

Set the 'ParticipationLevelCode' attribute value. To specify the level of participation by a vendor in another system. Refer to OpenTravel Code List 'Participation Level Code' (PLC).

Parameters:

participationLevelCode -

getDistance

public java.lang.Integer getDistance()

Get the 'Distance' attribute value. Miles acquired per flight segment, usually used for earning of frequent flyer miles.

Returns:

value

setDistance

public void setDistance(java.lang.Integer distance)

Set the 'Distance' attribute value. Miles acquired per flight segment, usually used for earning of frequent flyer miles.

Parameters:

distance -

getDateChangeNbr

public java.lang.String getDateChangeNbr()

Get the 'DateChangeNbr' attribute value. The number of days by which the flight's arrival date differs from its departure date (e.g., +1, -1).

Returns:

value

setDateChangeNbr

public void setDateChangeNbr(java.lang.String dateChangeNbr)

Set the 'DateChangeNbr' attribute value. The number of days by which the flight's arrival date differs from its departure date (e.g., +1, -1).

Parameters:

dateChangeNbr -

getValidConnectionInd

public java.lang.Boolean getValidConnectionInd()

Get the 'ValidConnectionInd' attribute value. When true, this flight segment constitutes a valid connection.

Returns:

value

setValidConnectionInd

public void setValidConnectionInd(java.lang.Boolean validConnectionInd)

Set the 'ValidConnectionInd' attribute value. When true, this flight segment constitutes a valid connection.

Parameters:

validConnectionInd -