org.ota.cruise
Class CabinAvailRS

java.lang.Object
  org.ota.cruise.CabinAvailRS

public class CabinAvailRS
extends java.lang.Object

The Cabin Availability Response message contains a list of cabins available for a given sailing with a specific Mode of Transportation/GatewayCity pair and currency and for a selected fare/category pair. For each cabin the following information may be returned: - Cabin number - Position in ship - Ship side - Category location - Remark - Deck name - Bed options - Max cabin occupancy - Remark - Cabin size - Berthed Category Code - Priced Category Code - Status code - Category indicator - Cruise package information - Group Code - Fare Code - Currency Code - 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_CruiseCabinAvailRS">
   <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="SelectedFare">
           <xs:complexType>
             <xs:attributeGroup ref="ns:FareGroup"/>
           </xs:complexType>
         </xs:element>
         <xs:element name="CabinOptions">
           <xs:complexType>
             <xs:sequence>
               <xs:element name="CabinOption" maxOccurs="99">
                 <!-- Reference to inner class CabinOption -->
               </xs:element>
             </xs:sequence>
           </xs:complexType>
         </xs:element>
         <xs:element type="ns:ParagraphType" name="Information" minOccurs="0" maxOccurs="5"/>
         <xs:element name="Dining" minOccurs="0" maxOccurs="8">
           <!-- Reference to inner class Dining -->
         </xs:element>
         <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:attributeGroup ref="ns:ResponseGroup"/>
   </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	CabinAvailRS.CabinOption Contains information about the proposed cabin, It locates the cabin on the ship and gives the cabin bed configuration.
static class	CabinAvailRS.Dining Schema fragment(s) for this class:

Constructor Summary

CabinAvailRS()

Method Summary

void	addCabinOption(CabinAvailRS.CabinOption item) Add a 'CabinOption' element item.
void	addDining(CabinAvailRS.Dining item) Add a 'Dining' element item.
void	addInformation(Paragraph item) Add a 'Information' element item.
void	clearCabinOptions() Remove all 'CabinOption' element items.
void	clearChoiceSelect() Clear the choice selection.
void	clearDinings() Remove all 'Dining' element items.
void	clearInformations() Remove all 'Information' element items.
CabinAvailRS.CabinOption	getCabinOption(int index) Get 'CabinOption' element item by position.
java.util.List<CabinAvailRS.CabinOption>	getCabinOptions() Get the list of 'CabinOption' element items.
CabinAvailRS.Dining	getDining(int index) Get 'Dining' element item by position.
java.util.List<CabinAvailRS.Dining>	getDinings() Get the list of 'Dining' 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.
ResponseGroup	getResponseGroup() Get the 'ResponseGroup' attributeGroup value.
SailingCategoryInfo	getSailingInfo() Get the 'SailingInfo' element value.
FareGroup	getSelectedFare() Get the 'FareGroup' attributeGroup 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	setCabinOptions(java.util.List<CabinAvailRS.CabinOption> list) Set the list of 'CabinOption' element items.
void	setDinings(java.util.List<CabinAvailRS.Dining> list) Set the list of 'Dining' 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	setResponseGroup(ResponseGroup responseGroup) Set the 'ResponseGroup' attributeGroup value.
void	setSailingInfo(SailingCategoryInfo sailingInfo) Set the 'SailingInfo' element value.
void	setSelectedFare(FareGroup selectedFare) Set the 'FareGroup' attributeGroup value.
void	setTPAExtensions(TPAExtensions TPAExtensions) Set the 'TPA_Extensions' element value.
void	setWarnings(Warnings warnings) Set the 'Warnings' element value.
int	sizeCabinOptions() Get the number of 'CabinOption' element items.
int	sizeDinings() Get the number of 'Dining' 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

CabinAvailRS

public CabinAvailRS()

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 -

getSelectedFare

public FareGroup getSelectedFare()

Get the 'FareGroup' attributeGroup value. Contains the information about the fare that has been selected from the previous fare availability response.

Returns:

value

setSelectedFare

public void setSelectedFare(FareGroup selectedFare)

Set the 'FareGroup' attributeGroup value. Contains the information about the fare that has been selected from the previous fare availability response.

Parameters:

selectedFare -

getCabinOptions

public java.util.List<CabinAvailRS.CabinOption> getCabinOptions()

Get the list of 'CabinOption' element items. Contains the list of proposed cabin options.

Returns:

list

setCabinOptions

public void setCabinOptions(java.util.List<CabinAvailRS.CabinOption> list)

Set the list of 'CabinOption' element items. Contains the list of proposed cabin options.

Parameters:

list -

sizeCabinOptions

public int sizeCabinOptions()

Get the number of 'CabinOption' element items.

Returns:

count

addCabinOption

public void addCabinOption(CabinAvailRS.CabinOption item)

Add a 'CabinOption' element item.

Parameters:

item -

getCabinOption

public CabinAvailRS.CabinOption getCabinOption(int index)

Get 'CabinOption' element item by position.

Parameters:

index -

Returns:

item

clearCabinOptions

public void clearCabinOptions()

Remove all 'CabinOption' 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.

getDinings

public java.util.List<CabinAvailRS.Dining> getDinings()

Get the list of 'Dining' element items.

Returns:

list

setDinings

public void setDinings(java.util.List<CabinAvailRS.Dining> list)

Set the list of 'Dining' element items.

Parameters:

list -

sizeDinings

public int sizeDinings()

Get the number of 'Dining' element items.

Returns:

count

addDining

public void addDining(CabinAvailRS.Dining item)

Add a 'Dining' element item.

Parameters:

item -

getDining

public CabinAvailRS.Dining getDining(int index)

Get 'Dining' element item by position.

Parameters:

index -

Returns:

item

clearDinings

public void clearDinings()

Remove all 'Dining' 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 -

getResponseGroup

public ResponseGroup getResponseGroup()

Get the 'ResponseGroup' attributeGroup value. Indicates that additional records are available and provides the echo token to be used to retrieve those records.

Returns:

value

setResponseGroup

public void setResponseGroup(ResponseGroup responseGroup)

Set the 'ResponseGroup' attributeGroup value. Indicates that additional records are available and provides the echo token to be used to retrieve those records.

Parameters:

responseGroup -