org.ota.cruise
Class ItineraryDescRS

java.lang.Object
  extended by org.ota.cruise.ItineraryDescRS

public class ItineraryDescRS
extends java.lang.Object

The cruise itinerary description response lists the entire itinerary of a specific sailing and returns detailed information about each location on the 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_CruiseItineraryDescRS">
   <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="SelectedSailing">
           <xs:complexType>
             <xs:attributeGroup ref="ns:SelectedSailingGroup"/>
           </xs:complexType>
         </xs:element>
         <xs:element name="CruiseItinInfos">
           <xs:complexType>
             <xs:sequence>
               <xs:element name="CruiseItinInfo" maxOccurs="99">
                 <!-- Reference to inner class CruiseItinInfo -->
               </xs:element>
             </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"/>
 


Nested Class Summary
static class ItineraryDescRS.CruiseItinInfo
          Identifies a specific location in the itinerary as well as the docking information.
 
Constructor Summary
ItineraryDescRS()
           
 
Method Summary
 void addCruiseItinInfo(ItineraryDescRS.CruiseItinInfo item)
          Add a 'CruiseItinInfo' element item.
 void clearChoiceSelect()
          Clear the choice selection.
 void clearCruiseItinInfos()
          Remove all 'CruiseItinInfo' element items.
 ItineraryDescRS.CruiseItinInfo getCruiseItinInfo(int index)
          Get 'CruiseItinInfo' element item by position.
 java.util.List<ItineraryDescRS.CruiseItinInfo> getCruiseItinInfos()
          Get the list of 'CruiseItinInfo' element items.
 Errors getErrors()
          Get the 'Errors' element value.
 OTAPayloadStdAttributes getOTAPayloadStdAttributes()
          Get the 'OTA_PayloadStdAttributes' attributeGroup value.
 SelectedSailingGroup getSelectedSailing()
          Get the 'SelectedSailingGroup' attributeGroup 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 setCruiseItinInfos(java.util.List<ItineraryDescRS.CruiseItinInfo> list)
          Set the list of 'CruiseItinInfo' element items.
 void setErrors(Errors errors)
          Set the 'Errors' element value.
 void setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes)
          Set the 'OTA_PayloadStdAttributes' attributeGroup value.
 void setSelectedSailing(SelectedSailingGroup selectedSailing)
          Set the 'SelectedSailingGroup' attributeGroup value.
 void setWarnings(Warnings warnings)
          Set the 'Warnings' element value.
 int sizeCruiseItinInfos()
          Get the number of 'CruiseItinInfo' element items.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ItineraryDescRS

public ItineraryDescRS()
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. Standard way to indicate successful processing of an OpenTravel message, but one in which warnings are generated.

Returns:
value

setWarnings

public void setWarnings(Warnings warnings)
Set the 'Warnings' element value. Standard way to indicate successful processing of an OpenTravel message, but one in which warnings are generated.

Parameters:
warnings -

getSelectedSailing

public SelectedSailingGroup getSelectedSailing()
Get the 'SelectedSailingGroup' attributeGroup value. This element specifies the sailing information

Returns:
value

setSelectedSailing

public void setSelectedSailing(SelectedSailingGroup selectedSailing)
Set the 'SelectedSailingGroup' attributeGroup value. This element specifies the sailing information

Parameters:
selectedSailing -

getCruiseItinInfos

public java.util.List<ItineraryDescRS.CruiseItinInfo> getCruiseItinInfos()
Get the list of 'CruiseItinInfo' element items. A collection of cruise itinerary infos.

Returns:
list

setCruiseItinInfos

public void setCruiseItinInfos(java.util.List<ItineraryDescRS.CruiseItinInfo> list)
Set the list of 'CruiseItinInfo' element items. A collection of cruise itinerary infos.

Parameters:
list -

sizeCruiseItinInfos

public int sizeCruiseItinInfos()
Get the number of 'CruiseItinInfo' element items.

Returns:
count

addCruiseItinInfo

public void addCruiseItinInfo(ItineraryDescRS.CruiseItinInfo item)
Add a 'CruiseItinInfo' element item.

Parameters:
item -

getCruiseItinInfo

public ItineraryDescRS.CruiseItinInfo getCruiseItinInfo(int index)
Get 'CruiseItinInfo' element item by position.

Parameters:
index -
Returns:
item

clearCruiseItinInfos

public void clearCruiseItinInfos()
Remove all 'CruiseItinInfo' element items.


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. A collection of errors that occurred during the processing of a message.

Returns:
value

setErrors

public void setErrors(Errors errors)
Set the 'Errors' element value. A collection of errors that occurred during the processing of a message.

Parameters:
errors -

getOTAPayloadStdAttributes

public OTAPayloadStdAttributes getOTAPayloadStdAttributes()
Get the 'OTA_PayloadStdAttributes' attributeGroup value. The standard attributes that appear on the root element for all OpenTravel Messages.

Returns:
value

setOTAPayloadStdAttributes

public void setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes)
Set the 'OTA_PayloadStdAttributes' attributeGroup value. The standard attributes that appear on the root element for all OpenTravel Messages.

Parameters:
OTAPayloadStdAttributes -