org.ota.cruise
Class CabinOption

java.lang.Object
  extended by org.ota.cruise.CabinOption
Direct Known Subclasses:
CabinAvailRS.CabinOption, SailingCategoryInfo.SelectedCategory.SelectedCabin

public class CabinOption
extends java.lang.Object

Specifies cabin option info. 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="CabinOptionType">
   <xs:sequence>
     <xs:element name="CabinConfiguration" minOccurs="0" maxOccurs="9">
       <!-- Reference to inner class CabinConfiguration -->
     </xs:element>
     <xs:element name="MeasurementInfo" minOccurs="0" maxOccurs="9">
       <!-- Reference to inner class MeasurementInfo -->
     </xs:element>
     <xs:element type="ns:FreeTextType" name="Remark" minOccurs="0"/>
   </xs:sequence>
   <xs:attribute type="xs:string" use="required" name="Status"/>
   <xs:attribute type="ns:CategoryLocationType" use="optional" name="CategoryLocation"/>
   <xs:attribute use="optional" name="ShipSide">
     <xs:simpleType>
       <!-- Reference to inner class ShipSide -->
     </xs:simpleType>
   </xs:attribute>
   <xs:attribute use="optional" name="PositionInShip">
     <xs:simpleType>
       <!-- Reference to inner class PositionInShip -->
     </xs:simpleType>
   </xs:attribute>
   <xs:attribute type="xs:string" use="optional" name="BedType"/>
   <xs:attributeGroup ref="ns:CruiseCabinGroup"/>
   <xs:attribute type="xs:dateTime" use="optional" name="ReleaseDateTime"/>
   <xs:attributeGroup ref="ns:DeckGroup"/>
   <xs:attribute type="xs:string" use="optional" name="CabinCategoryStatusCode"/>
   <xs:attribute type="xs:string" use="optional" name="CabinCategoryCode"/>
   <xs:attribute type="xs:int" use="optional" name="CabinRanking"/>
   <xs:attribute type="xs:boolean" use="optional" name="ConnectingCabinIndicator"/>
   <xs:attribute type="xs:string" use="optional" name="ConnectingCabinNumber"/>
 </xs:complexType>
 


Nested Class Summary
static class CabinOption.CabinConfiguration
          Specifies cabin bed configuration.
static class CabinOption.MeasurementInfo
          Provides area information related to the cabin.
static class CabinOption.PositionInShip
          Schema fragment(s) for this class:
static class CabinOption.ShipSide
          Schema fragment(s) for this class:
 
Constructor Summary
CabinOption()
           
 
Method Summary
 void addCabinConfiguration(CabinOption.CabinConfiguration item)
          Add a 'CabinConfiguration' element item.
 void addMeasurementInfo(CabinOption.MeasurementInfo item)
          Add a 'MeasurementInfo' element item.
 void clearCabinConfigurations()
          Remove all 'CabinConfiguration' element items.
 void clearMeasurementInfos()
          Remove all 'MeasurementInfo' element items.
 java.lang.String getBed()
          Get the 'BedType' attribute value.
 java.lang.String getCabinCategoryCode()
          Get the 'CabinCategoryCode' attribute value.
 java.lang.String getCabinCategoryStatusCode()
          Get the 'CabinCategoryStatusCode' attribute value.
 CabinOption.CabinConfiguration getCabinConfiguration(int index)
          Get 'CabinConfiguration' element item by position.
 java.util.List<CabinOption.CabinConfiguration> getCabinConfigurations()
          Get the list of 'CabinConfiguration' element items.
 java.lang.Integer getCabinRanking()
          Get the 'CabinRanking' attribute value.
 CategoryLocation getCategoryLocation()
          Get the 'CategoryLocation' attribute value.
 java.lang.Boolean getConnectingCabinIndicator()
          Get the 'ConnectingCabinIndicator' attribute value.
 java.lang.String getConnectingCabinNumber()
          Get the 'ConnectingCabinNumber' attribute value.
 CruiseCabinGroup getCruiseCabinGroup()
          Get the 'CruiseCabinGroup' attributeGroup value.
 DeckGroup getDeckGroup()
          Get the 'DeckGroup' attributeGroup value.
 CabinOption.MeasurementInfo getMeasurementInfo(int index)
          Get 'MeasurementInfo' element item by position.
 java.util.List<CabinOption.MeasurementInfo> getMeasurementInfos()
          Get the list of 'MeasurementInfo' element items.
 CabinOption.PositionInShip getPositionInShip()
          Get the 'PositionInShip' attribute value.
 java.util.Date getReleaseDateTime()
          Get the 'ReleaseDateTime' attribute value.
 FreeText getRemark()
          Get the 'Remark' element value.
 CabinOption.ShipSide getShipSide()
          Get the 'ShipSide' attribute value.
 java.lang.String getStatus()
          Get the 'Status' attribute value.
 void setBed(java.lang.String bed)
          Set the 'BedType' attribute value.
 void setCabinCategoryCode(java.lang.String cabinCategoryCode)
          Set the 'CabinCategoryCode' attribute value.
 void setCabinCategoryStatusCode(java.lang.String cabinCategoryStatusCode)
          Set the 'CabinCategoryStatusCode' attribute value.
 void setCabinConfigurations(java.util.List<CabinOption.CabinConfiguration> list)
          Set the list of 'CabinConfiguration' element items.
 void setCabinRanking(java.lang.Integer cabinRanking)
          Set the 'CabinRanking' attribute value.
 void setCategoryLocation(CategoryLocation categoryLocation)
          Set the 'CategoryLocation' attribute value.
 void setConnectingCabinIndicator(java.lang.Boolean connectingCabinIndicator)
          Set the 'ConnectingCabinIndicator' attribute value.
 void setConnectingCabinNumber(java.lang.String connectingCabinNumber)
          Set the 'ConnectingCabinNumber' attribute value.
 void setCruiseCabinGroup(CruiseCabinGroup cruiseCabinGroup)
          Set the 'CruiseCabinGroup' attributeGroup value.
 void setDeckGroup(DeckGroup deckGroup)
          Set the 'DeckGroup' attributeGroup value.
 void setMeasurementInfos(java.util.List<CabinOption.MeasurementInfo> list)
          Set the list of 'MeasurementInfo' element items.
 void setPositionInShip(CabinOption.PositionInShip positionInShip)
          Set the 'PositionInShip' attribute value.
 void setReleaseDateTime(java.util.Date releaseDateTime)
          Set the 'ReleaseDateTime' attribute value.
 void setRemark(FreeText remark)
          Set the 'Remark' element value.
 void setShipSide(CabinOption.ShipSide shipSide)
          Set the 'ShipSide' attribute value.
 void setStatus(java.lang.String status)
          Set the 'Status' attribute value.
 int sizeCabinConfigurations()
          Get the number of 'CabinConfiguration' element items.
 int sizeMeasurementInfos()
          Get the number of 'MeasurementInfo' element items.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CabinOption

public CabinOption()
Method Detail

getCabinConfigurations

public java.util.List<CabinOption.CabinConfiguration> getCabinConfigurations()
Get the list of 'CabinConfiguration' element items.

Returns:
list

setCabinConfigurations

public void setCabinConfigurations(java.util.List<CabinOption.CabinConfiguration> list)
Set the list of 'CabinConfiguration' element items.

Parameters:
list -

sizeCabinConfigurations

public int sizeCabinConfigurations()
Get the number of 'CabinConfiguration' element items.

Returns:
count

addCabinConfiguration

public void addCabinConfiguration(CabinOption.CabinConfiguration item)
Add a 'CabinConfiguration' element item.

Parameters:
item -

getCabinConfiguration

public CabinOption.CabinConfiguration getCabinConfiguration(int index)
Get 'CabinConfiguration' element item by position.

Parameters:
index -
Returns:
item

clearCabinConfigurations

public void clearCabinConfigurations()
Remove all 'CabinConfiguration' element items.


getMeasurementInfos

public java.util.List<CabinOption.MeasurementInfo> getMeasurementInfos()
Get the list of 'MeasurementInfo' element items.

Returns:
list

setMeasurementInfos

public void setMeasurementInfos(java.util.List<CabinOption.MeasurementInfo> list)
Set the list of 'MeasurementInfo' element items.

Parameters:
list -

sizeMeasurementInfos

public int sizeMeasurementInfos()
Get the number of 'MeasurementInfo' element items.

Returns:
count

addMeasurementInfo

public void addMeasurementInfo(CabinOption.MeasurementInfo item)
Add a 'MeasurementInfo' element item.

Parameters:
item -

getMeasurementInfo

public CabinOption.MeasurementInfo getMeasurementInfo(int index)
Get 'MeasurementInfo' element item by position.

Parameters:
index -
Returns:
item

clearMeasurementInfos

public void clearMeasurementInfos()
Remove all 'MeasurementInfo' element items.


getRemark

public FreeText getRemark()
Get the 'Remark' element value. Remark information related to the cabin option.

Returns:
value

setRemark

public void setRemark(FreeText remark)
Set the 'Remark' element value. Remark information related to the cabin option.

Parameters:
remark -

getStatus

public java.lang.String getStatus()
Get the 'Status' attribute value. Specifies the status of the cabin. Refer to OpenTravel Code table Status (STS).

Returns:
value

setStatus

public void setStatus(java.lang.String status)
Set the 'Status' attribute value. Specifies the status of the cabin. Refer to OpenTravel Code table Status (STS).

Parameters:
status -

getCategoryLocation

public CategoryLocation getCategoryLocation()
Get the 'CategoryLocation' attribute value. Specifies the category location.

Returns:
value

setCategoryLocation

public void setCategoryLocation(CategoryLocation categoryLocation)
Set the 'CategoryLocation' attribute value. Specifies the category location.

Parameters:
categoryLocation -

getShipSide

public CabinOption.ShipSide getShipSide()
Get the 'ShipSide' attribute value. Identifies the ship side location of the cabin.

Returns:
value

setShipSide

public void setShipSide(CabinOption.ShipSide shipSide)
Set the 'ShipSide' attribute value. Identifies the ship side location of the cabin.

Parameters:
shipSide -

getPositionInShip

public CabinOption.PositionInShip getPositionInShip()
Get the 'PositionInShip' attribute value. Position of the cabin in ship (e.g., aft).

Returns:
value

setPositionInShip

public void setPositionInShip(CabinOption.PositionInShip positionInShip)
Set the 'PositionInShip' attribute value. Position of the cabin in ship (e.g., aft).

Parameters:
positionInShip -

getBed

public java.lang.String getBed()
Get the 'BedType' attribute value. Specifies the bed type for this cabin. Refer to OpenTravel Codelist Bed Type (BED).

Returns:
value

setBed

public void setBed(java.lang.String bed)
Set the 'BedType' attribute value. Specifies the bed type for this cabin. Refer to OpenTravel Codelist Bed Type (BED).

Parameters:
bed -

getCruiseCabinGroup

public CruiseCabinGroup getCruiseCabinGroup()
Get the 'CruiseCabinGroup' attributeGroup value.

Returns:
value

setCruiseCabinGroup

public void setCruiseCabinGroup(CruiseCabinGroup cruiseCabinGroup)
Set the 'CruiseCabinGroup' attributeGroup value.

Parameters:
cruiseCabinGroup -

getReleaseDateTime

public java.util.Date getReleaseDateTime()
Get the 'ReleaseDateTime' attribute value. The date and time the held cabin will be released back to inventory if not booked. Typically, this is the same ReleaseDateTime that was provided in the CabinHoldRS.

Returns:
value

setReleaseDateTime

public void setReleaseDateTime(java.util.Date releaseDateTime)
Set the 'ReleaseDateTime' attribute value. The date and time the held cabin will be released back to inventory if not booked. Typically, this is the same ReleaseDateTime that was provided in the CabinHoldRS.

Parameters:
releaseDateTime -

getDeckGroup

public DeckGroup getDeckGroup()
Get the 'DeckGroup' attributeGroup value. Provides the deck name and number.

Returns:
value

setDeckGroup

public void setDeckGroup(DeckGroup deckGroup)
Set the 'DeckGroup' attributeGroup value. Provides the deck name and number.

Parameters:
deckGroup -

getCabinCategoryStatusCode

public java.lang.String getCabinCategoryStatusCode()
Get the 'CabinCategoryStatusCode' attribute value. The status of the berth category of the cabin. Refer to OpenTravel Code Table STS (Status).

Returns:
value

setCabinCategoryStatusCode

public void setCabinCategoryStatusCode(java.lang.String cabinCategoryStatusCode)
Set the 'CabinCategoryStatusCode' attribute value. The status of the berth category of the cabin. Refer to OpenTravel Code Table STS (Status).

Parameters:
cabinCategoryStatusCode -

getCabinCategoryCode

public java.lang.String getCabinCategoryCode()
Get the 'CabinCategoryCode' attribute value. The berth category of the cabin.

Returns:
value

setCabinCategoryCode

public void setCabinCategoryCode(java.lang.String cabinCategoryCode)
Set the 'CabinCategoryCode' attribute value. The berth category of the cabin.

Parameters:
cabinCategoryCode -

getCabinRanking

public java.lang.Integer getCabinRanking()
Get the 'CabinRanking' attribute value. The relative ranking of the cabin based on location preference, a better view, etc.

Returns:
value

setCabinRanking

public void setCabinRanking(java.lang.Integer cabinRanking)
Set the 'CabinRanking' attribute value. The relative ranking of the cabin based on location preference, a better view, etc.

Parameters:
cabinRanking -

getConnectingCabinIndicator

public java.lang.Boolean getConnectingCabinIndicator()
Get the 'ConnectingCabinIndicator' attribute value. If true, the cabin is connected to another cabin.

Returns:
value

setConnectingCabinIndicator

public void setConnectingCabinIndicator(java.lang.Boolean connectingCabinIndicator)
Set the 'ConnectingCabinIndicator' attribute value. If true, the cabin is connected to another cabin.

Parameters:
connectingCabinIndicator -

getConnectingCabinNumber

public java.lang.String getConnectingCabinNumber()
Get the 'ConnectingCabinNumber' attribute value. The number of the connecting cabin.

Returns:
value

setConnectingCabinNumber

public void setConnectingCabinNumber(java.lang.String connectingCabinNumber)
Set the 'ConnectingCabinNumber' attribute value. The number of the connecting cabin.

Parameters:
connectingCabinNumber -