org.ota.cruise
Class DiningAvailRS

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

public class DiningAvailRS
extends java.lang.Object

The Dining Availability Response message contains a list of dinings available for a given sailing and for a selected fare. For each dining the following information may be returned: - Dining Code - Dining status - Sittiing - Meal name - Meal times - Marketing message. 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_CruiseDiningAvailRS">
   <xs:complexType>
     <xs:choice>
       <xs:sequence>
         <xs:element type="ns:SuccessType" name="Success"/>
         <xs:element type="ns:WarningsType" name="Warnings" minOccurs="0"/>
         <xs:element type="ns:SailingCategoryInfoType" name="SailingInfo"/>
         <xs:element name="DiningOptions">
           <xs:complexType>
             <xs:sequence>
               <xs:element name="DiningOption" maxOccurs="99">
                 <!-- Reference to inner class DiningOption -->
               </xs:element>
             </xs:sequence>
           </xs:complexType>
         </xs:element>
         <xs:element type="ns:ParagraphType" name="Information" minOccurs="0" maxOccurs="5"/>
         <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
       </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 DiningAvailRS.DiningOption
          Contains information about the proposed dining.
 
Constructor Summary
DiningAvailRS()
           
 
Method Summary
 void addDiningOption(DiningAvailRS.DiningOption item)
          Add a 'DiningOption' element item.
 void addInformation(Paragraph item)
          Add a 'Information' element item.
 void clearChoiceSelect()
          Clear the choice selection.
 void clearDiningOptions()
          Remove all 'DiningOption' element items.
 void clearInformations()
          Remove all 'Information' element items.
 DiningAvailRS.DiningOption getDiningOption(int index)
          Get 'DiningOption' element item by position.
 java.util.List<DiningAvailRS.DiningOption> getDiningOptions()
          Get the list of 'DiningOption' element items.
 Errors getErrors()
          Get the 'Errors' element value.
 Paragraph getInformation(int index)
          Get 'Information' element item by position.
 java.util.List<Paragraph> getInformations()
          Get the list of 'Information' element items.
 OTAPayloadStdAttributes getOTAPayloadStdAttributes()
          Get the 'OTA_PayloadStdAttributes' attributeGroup value.
 SailingCategoryInfo getSailingInfo()
          Get the 'SailingInfo' element value.
 TPAExtensions getTPAExtensions()
          Get the 'TPA_Extensions' 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 setDiningOptions(java.util.List<DiningAvailRS.DiningOption> list)
          Set the list of 'DiningOption' element items.
 void setErrors(Errors errors)
          Set the 'Errors' element value.
 void setInformations(java.util.List<Paragraph> list)
          Set the list of 'Information' element items.
 void setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes)
          Set the 'OTA_PayloadStdAttributes' attributeGroup value.
 void setSailingInfo(SailingCategoryInfo sailingInfo)
          Set the 'SailingInfo' element value.
 void setTPAExtensions(TPAExtensions TPAExtensions)
          Set the 'TPA_Extensions' element value.
 void setWarnings(Warnings warnings)
          Set the 'Warnings' element value.
 int sizeDiningOptions()
          Get the number of 'DiningOption' element items.
 int sizeInformations()
          Get the number of 'Information' element items.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DiningAvailRS

public DiningAvailRS()
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 -

getSailingInfo

public SailingCategoryInfo getSailingInfo()
Get the 'SailingInfo' element value. Requested sailing information. Specifies the selected category that the cabins belong to. It is the category that has been selected in the previous category availability response.

Returns:
value

setSailingInfo

public void setSailingInfo(SailingCategoryInfo sailingInfo)
Set the 'SailingInfo' element value. Requested sailing information. Specifies the selected category that the cabins belong to. It is the category that has been selected in the previous category availability response.

Parameters:
sailingInfo -

getDiningOptions

public java.util.List<DiningAvailRS.DiningOption> getDiningOptions()
Get the list of 'DiningOption' element items. Contains the list of proposed dining options.

Returns:
list

setDiningOptions

public void setDiningOptions(java.util.List<DiningAvailRS.DiningOption> list)
Set the list of 'DiningOption' element items. Contains the list of proposed dining options.

Parameters:
list -

sizeDiningOptions

public int sizeDiningOptions()
Get the number of 'DiningOption' element items.

Returns:
count

addDiningOption

public void addDiningOption(DiningAvailRS.DiningOption item)
Add a 'DiningOption' element item.

Parameters:
item -

getDiningOption

public DiningAvailRS.DiningOption getDiningOption(int index)
Get 'DiningOption' element item by position.

Parameters:
index -
Returns:
item

clearDiningOptions

public void clearDiningOptions()
Remove all 'DiningOption' element items.


getInformations

public java.util.List<Paragraph> getInformations()
Get the list of 'Information' element items. Contains information such as advisories or marketing messages returned by the cruise line.

Returns:
list

setInformations

public void setInformations(java.util.List<Paragraph> list)
Set the list of 'Information' element items. Contains information such as advisories or marketing messages returned by the cruise line.

Parameters:
list -

sizeInformations

public int sizeInformations()
Get the number of 'Information' element items.

Returns:
count

addInformation

public void addInformation(Paragraph item)
Add a 'Information' element item.

Parameters:
item -

getInformation

public Paragraph getInformation(int index)
Get 'Information' element item by position.

Parameters:
index -
Returns:
item

clearInformations

public void clearInformations()
Remove all 'Information' element items.


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 -

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 -