org.ota.itin
Class RS

java.lang.Object
  extended by org.ota.itin.RS

public class RS
extends java.lang.Object

This message is in response to a read RQ for a travel itinerary. 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_TravelItineraryRS">
   <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="TravelItinerary">
           <xs:complexType>
             <xs:sequence>
               <xs:element type="ns:UniqueID_Type" name="ItineraryRef"/>
               <xs:element name="CustomerInfos">
                 <xs:complexType>
                   <xs:sequence>
                     <xs:element type="ns:CustomerInfoType" name="CustomerInfo" maxOccurs="unbounded"/>
                     <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
                   </xs:sequence>
                 </xs:complexType>
               </xs:element>
               <xs:element type="ns:ItineraryInfoType" name="ItineraryInfo"/>
               <xs:element type="ns:AssociatedContentType" name="AssociatedContent" minOccurs="0"/>
               <xs:element type="ns:TravelCostType" name="TravelCost" minOccurs="0"/>
               <xs:element name="Remarks" minOccurs="0">
                 <!-- Reference to inner class Remarks -->
               </xs:element>
               <xs:element type="ns:AccessesType" name="UpdatedBy"/>
               <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
             </xs:sequence>
           </xs:complexType>
         </xs:element>
       </xs:sequence>
       <xs:element type="ns:ErrorsType" name="Errors"/>
     </xs:choice>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
   </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: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 RS.Remarks
          Free text remarks associated with the itinerary (non-customer, non-item).
 
Constructor Summary
RS()
           
 
Method Summary
 void addTravelItineraryCustomerInfo(CustomerInfo item)
          Add a 'CustomerInfo' element item.
 void clearChoiceSelect()
          Clear the choice selection.
 void clearTravelItineraryCustomerInfos()
          Remove all 'CustomerInfo' element items.
 Errors getErrors()
          Get the 'Errors' element value.
 OTAPayloadStdAttributes getOTAPayloadStdAttributes()
          Get the 'OTA_PayloadStdAttributes' attributeGroup value.
 RS.Remarks getRemarks()
          Get the 'Remarks' element value.
 AssociatedContent getTravelItineraryAssociatedContent()
          Get the 'AssociatedContent' element value.
 CustomerInfo getTravelItineraryCustomerInfo(int index)
          Get 'CustomerInfo' element item by position.
 java.util.List<CustomerInfo> getTravelItineraryCustomerInfos()
          Get the list of 'CustomerInfo' element items.
 ItineraryInfo getTravelItineraryItineraryInfo()
          Get the 'ItineraryInfo' element value.
 UniqueID getTravelItineraryItineraryRef()
          Get the 'ItineraryRef' element value.
 TPAExtensions getTravelItineraryTPAExtensions()
          Get the 'TPA_Extensions' element value.
 TPAExtensions getTravelItineraryTPAExtensions1()
          Get the 'TPA_Extensions' element value.
 TravelCost getTravelItineraryTravelCost()
          Get the 'TravelCost' element value.
 Accesses getTravelItineraryUpdatedBy()
          Get the 'UpdatedBy' element 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 setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes)
          Set the 'OTA_PayloadStdAttributes' attributeGroup value.
 void setRemarks(RS.Remarks remarks)
          Set the 'Remarks' element value.
 void setTravelItineraryAssociatedContent(AssociatedContent travelItineraryAssociatedContent)
          Set the 'AssociatedContent' element value.
 void setTravelItineraryCustomerInfos(java.util.List<CustomerInfo> list)
          Set the list of 'CustomerInfo' element items.
 void setTravelItineraryItineraryInfo(ItineraryInfo travelItineraryItineraryInfo)
          Set the 'ItineraryInfo' element value.
 void setTravelItineraryItineraryRef(UniqueID travelItineraryItineraryRef)
          Set the 'ItineraryRef' element value.
 void setTravelItineraryTPAExtensions(TPAExtensions travelItineraryTPAExtensions)
          Set the 'TPA_Extensions' element value.
 void setTravelItineraryTPAExtensions1(TPAExtensions travelItineraryTPAExtensions1)
          Set the 'TPA_Extensions' element value.
 void setTravelItineraryTravelCost(TravelCost travelItineraryTravelCost)
          Set the 'TravelCost' element value.
 void setTravelItineraryUpdatedBy(Accesses travelItineraryUpdatedBy)
          Set the 'UpdatedBy' element value.
 void setWarnings(Warnings warnings)
          Set the 'Warnings' element value.
 int sizeTravelItineraryCustomerInfos()
          Get the number of 'CustomerInfo' element items.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RS

public RS()
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. Warnings associated with a successful request/response.

Returns:
value

setWarnings

public void setWarnings(Warnings warnings)
Set the 'Warnings' element value. Warnings associated with a successful request/response.

Parameters:
warnings -

getTravelItineraryItineraryRef

public UniqueID getTravelItineraryItineraryRef()
Get the 'ItineraryRef' element value. Controlling system's reference to this itinerary.

Returns:
value

setTravelItineraryItineraryRef

public void setTravelItineraryItineraryRef(UniqueID travelItineraryItineraryRef)
Set the 'ItineraryRef' element value. Controlling system's reference to this itinerary.

Parameters:
travelItineraryItineraryRef -

getTravelItineraryCustomerInfos

public java.util.List<CustomerInfo> getTravelItineraryCustomerInfos()
Get the list of 'CustomerInfo' element items. Information for each customer associated with this itinerary.

Returns:
list

setTravelItineraryCustomerInfos

public void setTravelItineraryCustomerInfos(java.util.List<CustomerInfo> list)
Set the list of 'CustomerInfo' element items. Information for each customer associated with this itinerary.

Parameters:
list -

sizeTravelItineraryCustomerInfos

public int sizeTravelItineraryCustomerInfos()
Get the number of 'CustomerInfo' element items.

Returns:
count

addTravelItineraryCustomerInfo

public void addTravelItineraryCustomerInfo(CustomerInfo item)
Add a 'CustomerInfo' element item.

Parameters:
item -

getTravelItineraryCustomerInfo

public CustomerInfo getTravelItineraryCustomerInfo(int index)
Get 'CustomerInfo' element item by position.

Parameters:
index -
Returns:
item

clearTravelItineraryCustomerInfos

public void clearTravelItineraryCustomerInfos()
Remove all 'CustomerInfo' element items.


getTravelItineraryTPAExtensions

public TPAExtensions getTravelItineraryTPAExtensions()
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

setTravelItineraryTPAExtensions

public void setTravelItineraryTPAExtensions(TPAExtensions travelItineraryTPAExtensions)
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:
travelItineraryTPAExtensions -

getTravelItineraryItineraryInfo

public ItineraryInfo getTravelItineraryItineraryInfo()
Get the 'ItineraryInfo' element value. Itinerary reservation information. USAGE: SpecialRequestDetails-->SeatRequest-->TravellerRefNumber-->RPH serves as a link to: OTA_TravelItineraryRS-->TravelItinerary-->CustomerInfos-->CustomerInfo-->RPH USAGE: SpecialRequestDetails-->SeatRequest-->FlightRefNumber-->RPH serves as a link to: ReservationItems-->Item-->Air-->RPH

Returns:
value

setTravelItineraryItineraryInfo

public void setTravelItineraryItineraryInfo(ItineraryInfo travelItineraryItineraryInfo)
Set the 'ItineraryInfo' element value. Itinerary reservation information. USAGE: SpecialRequestDetails-->SeatRequest-->TravellerRefNumber-->RPH serves as a link to: OTA_TravelItineraryRS-->TravelItinerary-->CustomerInfos-->CustomerInfo-->RPH USAGE: SpecialRequestDetails-->SeatRequest-->FlightRefNumber-->RPH serves as a link to: ReservationItems-->Item-->Air-->RPH

Parameters:
travelItineraryItineraryInfo -

getTravelItineraryAssociatedContent

public AssociatedContent getTravelItineraryAssociatedContent()
Get the 'AssociatedContent' element value. Associated itinerary information such as theatre tickets, museum entries, conference tickets, sporting event, etc.

Returns:
value

setTravelItineraryAssociatedContent

public void setTravelItineraryAssociatedContent(AssociatedContent travelItineraryAssociatedContent)
Set the 'AssociatedContent' element value. Associated itinerary information such as theatre tickets, museum entries, conference tickets, sporting event, etc.

Parameters:
travelItineraryAssociatedContent -

getTravelItineraryTravelCost

public TravelCost getTravelItineraryTravelCost()
Get the 'TravelCost' element value. Total cost associated with the entire itinerary.

Returns:
value

setTravelItineraryTravelCost

public void setTravelItineraryTravelCost(TravelCost travelItineraryTravelCost)
Set the 'TravelCost' element value. Total cost associated with the entire itinerary.

Parameters:
travelItineraryTravelCost -

getRemarks

public RS.Remarks getRemarks()
Get the 'Remarks' element value. Requested itinerary information.

Returns:
value

setRemarks

public void setRemarks(RS.Remarks remarks)
Set the 'Remarks' element value. Requested itinerary information.

Parameters:
remarks -

getTravelItineraryUpdatedBy

public Accesses getTravelItineraryUpdatedBy()
Get the 'UpdatedBy' element value. Information on the last entity to modify this Itinerary and when this occurred.

Returns:
value

setTravelItineraryUpdatedBy

public void setTravelItineraryUpdatedBy(Accesses travelItineraryUpdatedBy)
Set the 'UpdatedBy' element value. Information on the last entity to modify this Itinerary and when this occurred.

Parameters:
travelItineraryUpdatedBy -

getTravelItineraryTPAExtensions1

public TPAExtensions getTravelItineraryTPAExtensions1()
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

setTravelItineraryTPAExtensions1

public void setTravelItineraryTPAExtensions1(TPAExtensions travelItineraryTPAExtensions1)
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:
travelItineraryTPAExtensions1 -

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. Request was not successful - error information.

Returns:
value

setErrors

public void setErrors(Errors errors)
Set the 'Errors' element value. Request was not successful - error information.

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 -