org.ota.cruise
Class CategoryAvailRQ

java.lang.Object
  org.ota.cruise.CategoryAvailRQ

public class CategoryAvailRQ
extends java.lang.Object

The Category Availability Request message requests Category Availability for a given sailing with a specific Mode of Transportation/GatewayCity pair and currency and for selected fares (depending on the cruise line). Optional request information can include: - Guest ages - 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_CruiseCategoryAvailRQ">
   <xs:complexType>
     <xs:sequence>
       <xs:element type="ns:POS_Type" name="POS"/>
       <xs:element type="ns:GuestType" name="Guest" 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:SailingInfoType" name="SailingInfo"/>
       <xs:element name="SearchQualifiers" minOccurs="0">
         <!-- Reference to inner class SearchQualifiers -->
       </xs:element>
       <xs:element name="SelectedFare" maxOccurs="5">
         <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: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

CategoryAvailRQ.SearchQualifiers Used to further qualify the category availability search.

Constructor Summary

CategoryAvailRQ()

Method Summary

void	addGuest(Guest item) Add a 'Guest' element item.
void	addGuestCount(TravelerCountGroup item) Add a 'GuestCount' element item.
void	addSelectedFare(FareGroup item) Add a 'SelectedFare' element item.
void	clearGuestCounts() Remove all 'GuestCount' element items.
void	clearGuests() Remove all 'Guest' element items.
void	clearSelectedFares() Remove all 'SelectedFare' 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.
SailingInfo	getSailingInfo() Get the 'SailingInfo' element value.
CategoryAvailRQ.SearchQualifiers	getSearchQualifiers() Get the 'SearchQualifiers' element value.
FareGroup	getSelectedFare(int index) Get 'SelectedFare' element item by position.
java.util.List<FareGroup>	getSelectedFares() Get the list of 'SelectedFare' element items.
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	setSailingInfo(SailingInfo sailingInfo) Set the 'SailingInfo' element value.
void	setSearchQualifiers(CategoryAvailRQ.SearchQualifiers searchQualifiers) Set the 'SearchQualifiers' element value.
void	setSelectedFares(java.util.List<FareGroup> list) Set the list of 'SelectedFare' element items.
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.
int	sizeSelectedFares() Get the number of 'SelectedFare' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoryAvailRQ

public CategoryAvailRQ()

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.

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.

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 SailingInfo 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.

Returns:

value

setSailingInfo

public void setSailingInfo(SailingInfo 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.

Parameters:

sailingInfo -

getSearchQualifiers

public CategoryAvailRQ.SearchQualifiers getSearchQualifiers()

Get the 'SearchQualifiers' element value.

Returns:

value

setSearchQualifiers

public void setSearchQualifiers(CategoryAvailRQ.SearchQualifiers searchQualifiers)

Set the 'SearchQualifiers' element value.

Parameters:

searchQualifiers -

getSelectedFares

public java.util.List<FareGroup> getSelectedFares()

Get the list of 'SelectedFare' element items. Specifies the fare code and the group code.

Returns:

list

setSelectedFares

public void setSelectedFares(java.util.List<FareGroup> list)

Set the list of 'SelectedFare' element items. Specifies the fare code and the group code.

Parameters:

list -

sizeSelectedFares

public int sizeSelectedFares()

Get the number of 'SelectedFare' element items.

Returns:

count

addSelectedFare

public void addSelectedFare(FareGroup item)

Add a 'SelectedFare' element item.

Parameters:

item -

getSelectedFare

public FareGroup getSelectedFare(int index)

Get 'SelectedFare' element item by position.

Parameters:

index -

Returns:

item

clearSelectedFares

public void clearSelectedFares()

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

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 -