org.ota.cruise
Class CabinAvailRQ

java.lang.Object
  org.ota.cruise.CabinAvailRQ

public class CabinAvailRQ
extends java.lang.Object

The Cabin Availability Request message requests Cabin Availability for a given sailing with a specific Mode of Transportation/GatewayCity pair and currency and for a selected fare/category pair. Optional request information can include: - Guest city - Inclusive package 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_CruiseCabinAvailRQ">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:POS_Type" name="POS"/>
       <xs:element type="ns:GuestType" name="Guest" minOccurs="0" maxOccurs="9"/>
       <xs:element name="GuestCounts">
         <xs:complexType>
           <xs:sequence>
             <xs:element name="GuestCount" maxOccurs="9">
               <xs:complexType>
                 <xs:attributeGroup ref="ns:TravelerCountGroup"/>
               </xs:complexType>
             </xs:element>
           </xs:sequence>
         </xs:complexType>
       </xs:element>
       <xs:element type="ns:SailingCategoryInfoType" name="SailingInfo"/>
       <xs:element name="SearchQualifiers" minOccurs="0">
         <!-- Reference to inner class SearchQualifiers -->
       </xs:element>
       <xs:element name="SelectedFare">
         <xs:complexType>
           <xs:attributeGroup ref="ns:FareGroup"/>
         </xs:complexType>
       </xs:element>
       <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
     </xs:sequence>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
     <xs:attributeGroup ref="ns:ResponseGroup"/>
   </xs:complexType>
 </xs:element>
 
 <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

CabinAvailRQ.SearchQualifiers Used to further qualify the cabin availability search.

Constructor Summary

CabinAvailRQ()

Method Summary

void	addGuest(Guest item) Add a 'Guest' element item.
void	addGuestCount(TravelerCountGroup item) Add a 'GuestCount' element item.
void	clearGuestCounts() Remove all 'GuestCount' element items.
void	clearGuests() Remove all 'Guest' element items.
Guest	getGuest(int index) Get 'Guest' element item by position.
TravelerCountGroup	getGuestCount(int index) Get 'GuestCount' element item by position.
java.util.List<TravelerCountGroup>	getGuestCounts() Get the list of 'GuestCount' element items.
java.util.List<Guest>	getGuests() Get the list of 'Guest' element items.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
POS	getPOS() Get the 'POS' element value.
ResponseGroup	getResponseGroup() Get the 'ResponseGroup' attributeGroup value.
SailingCategoryInfo	getSailingInfo() Get the 'SailingInfo' element value.
CabinAvailRQ.SearchQualifiers	getSearchQualifiers() Get the 'SearchQualifiers' element value.
FareGroup	getSelectedFare() Get the 'FareGroup' attributeGroup value.
TPAExtensions	getTPAExtensions() Get the 'TPA_Extensions' element value.
void	setGuestCounts(java.util.List<TravelerCountGroup> list) Set the list of 'GuestCount' element items.
void	setGuests(java.util.List<Guest> list) Set the list of 'Guest' element items.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setPOS(POS POS) Set the 'POS' element value.
void	setResponseGroup(ResponseGroup responseGroup) Set the 'ResponseGroup' attributeGroup value.
void	setSailingInfo(SailingCategoryInfo sailingInfo) Set the 'SailingInfo' element value.
void	setSearchQualifiers(CabinAvailRQ.SearchQualifiers searchQualifiers) Set the 'SearchQualifiers' element value.
void	setSelectedFare(FareGroup selectedFare) Set the 'FareGroup' attributeGroup value.
void	setTPAExtensions(TPAExtensions TPAExtensions) Set the 'TPA_Extensions' element value.
int	sizeGuestCounts() Get the number of 'GuestCount' element items.
int	sizeGuests() Get the number of 'Guest' element items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CabinAvailRQ

public CabinAvailRQ()

Method Detail

getPOS

public POS getPOS()

Get the 'POS' element value. Point of sale object.

Returns:

value

setPOS

public void setPOS(POS POS)

Set the 'POS' element value. Point of sale object.

Parameters:

POS -

getGuests

public java.util.List<Guest> getGuests()

Get the list of 'Guest' element items. Specifies guest names and/or their transportation regarding the guest staying in the cabin.

Returns:

list

setGuests

public void setGuests(java.util.List<Guest> list)

Set the list of 'Guest' element items. Specifies guest names and/or their transportation regarding the guest staying in the cabin.

Parameters:

list -

sizeGuests

public int sizeGuests()

Get the number of 'Guest' element items.

Returns:

count

addGuest

public void addGuest(Guest item)

Add a 'Guest' element item.

Parameters:

item -

getGuest

public Guest getGuest(int index)

Get 'Guest' element item by position.

Parameters:

index -

Returns:

item

clearGuests

public void clearGuests()

Remove all 'Guest' element items.

getGuestCounts

public java.util.List<TravelerCountGroup> getGuestCounts()

Get the list of 'GuestCount' element items. Specifies guest quantity and guest types.

Returns:

list

setGuestCounts

public void setGuestCounts(java.util.List<TravelerCountGroup> list)

Set the list of 'GuestCount' element items. Specifies guest quantity and guest types.

Parameters:

list -

sizeGuestCounts

public int sizeGuestCounts()

Get the number of 'GuestCount' element items.

Returns:

count

addGuestCount

public void addGuestCount(TravelerCountGroup item)

Add a 'GuestCount' element item.

Parameters:

item -

getGuestCount

public TravelerCountGroup getGuestCount(int index)

Get 'GuestCount' element item by position.

Parameters:

index -

Returns:

item

clearGuestCounts

public void clearGuestCounts()

Remove all 'GuestCount' element items.

getSailingInfo

public SailingCategoryInfo getSailingInfo()

Get the 'SailingInfo' element value. Contains information related to the selected sailing. Typically the selected sailing is one of the sailings returned in the previous sailing availability response. Used to request a package option that the cruise might offer with the sailing. It is quite common to request, at this stage, packages that are included in the cruise sailing offering (inclusive packages).

Returns:

value

setSailingInfo

public void setSailingInfo(SailingCategoryInfo sailingInfo)

Set the 'SailingInfo' element value. Contains information related to the selected sailing. Typically the selected sailing is one of the sailings returned in the previous sailing availability response. Used to request a package option that the cruise might offer with the sailing. It is quite common to request, at this stage, packages that are included in the cruise sailing offering (inclusive packages).

Parameters:

sailingInfo -

getSearchQualifiers

public CabinAvailRQ.SearchQualifiers getSearchQualifiers()

Get the 'SearchQualifiers' element value.

Returns:

value

setSearchQualifiers

public void setSearchQualifiers(CabinAvailRQ.SearchQualifiers searchQualifiers)

Set the 'SearchQualifiers' element value.

Parameters:

searchQualifiers -

getSelectedFare

public FareGroup getSelectedFare()

Get the 'FareGroup' attributeGroup value. Specifies the fare code and the group code if any. Fare codes are specific to cruise lines.

Returns:

value

setSelectedFare

public void setSelectedFare(FareGroup selectedFare)

Set the 'FareGroup' attributeGroup value. Specifies the fare code and the group code if any. Fare codes are specific to cruise lines.

Parameters:

selectedFare -

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 -

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. Provides the echo token to be used to retrieve additional records.

Returns:

value

setResponseGroup

public void setResponseGroup(ResponseGroup responseGroup)

Set the 'ResponseGroup' attributeGroup value. Provides the echo token to be used to retrieve additional records.

Parameters:

responseGroup -