org.ota.cruise
Class SailAvailRQ

java.lang.Object
  org.ota.cruise.SailAvailRQ

public class SailAvailRQ
extends java.lang.Object

The Sailing Availability Request message requests Sailing Availability for a geographical region on a specific date for a specific number and passengers. Optional request information can include: - Cruise lines - Ship codes The request can be narrowed to request availability for a specific cruise line or specific ship. 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_CruiseSailAvailRQ">
   <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" minOccurs="0">
         <!-- Reference to inner class GuestCounts -->
       </xs:element>
       <xs:element name="SailingDateRange">
         <xs:complexType>
           <xs:complexContent>
             <xs:extension base="ns:DateTimeSpanType">
               <xs:attributeGroup ref="ns:DurationGroup"/>
             </xs:extension>
           </xs:complexContent>
         </xs:complexType>
       </xs:element>
       <xs:element name="CruiseLinePrefs" minOccurs="0">
         <!-- Reference to inner class CruiseLinePrefs -->
       </xs:element>
       <xs:element name="RegionPref" minOccurs="0" maxOccurs="5">
         <xs:complexType>
           <xs:attributeGroup ref="ns:RegionGroup"/>
         </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:attributeGroup xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="DurationGroup">
   <xs:attribute type="xs:string" use="optional" name="MinDuration"/>
   <xs:attribute type="xs:string" use="optional" name="MaxDuration"/>
   <xs:attribute type="xs:string" use="optional" name="ListOfDurations"/>
 </xs:attributeGroup>
 
 <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	SailAvailRQ.CruiseLinePrefs Collection of cruise line preferences.
static class	SailAvailRQ.GuestCounts Specifies guest quantity and guest types.

Constructor Summary

SailAvailRQ()

Method Summary

void	addGuest(Guest item) Add a 'Guest' element item.
void	addRegionPref(RegionGroup item) Add a 'RegionPref' element item.
void	clearGuests() Remove all 'Guest' element items.
void	clearRegionPrefs() Remove all 'RegionPref' element items.
SailAvailRQ.CruiseLinePrefs	getCruiseLinePrefs() Get the 'CruiseLinePrefs' element value.
Guest	getGuest(int index) Get 'Guest' element item by position.
SailAvailRQ.GuestCounts	getGuestCounts() Get the 'GuestCounts' element value.
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.
RegionGroup	getRegionPref(int index) Get 'RegionPref' element item by position.
java.util.List<RegionGroup>	getRegionPrefs() Get the list of 'RegionPref' element items.
ResponseGroup	getResponseGroup() Get the 'ResponseGroup' attributeGroup value.
DateTimeSpan	getSailingDateRangeDateTimeSpan() Get the extension value.
java.lang.String	getSailingDateRangeListOfDurations() Get the 'ListOfDurations' attribute value.
java.lang.String	getSailingDateRangeMaxDuration() Get the 'MaxDuration' attribute value.
java.lang.String	getSailingDateRangeMinDuration() Get the 'MinDuration' attribute value.
TPAExtensions	getTPAExtensions() Get the 'TPA_Extensions' element value.
void	setCruiseLinePrefs(SailAvailRQ.CruiseLinePrefs cruiseLinePrefs) Set the 'CruiseLinePrefs' element value.
void	setGuestCounts(SailAvailRQ.GuestCounts guestCounts) Set the 'GuestCounts' element value.
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	setRegionPrefs(java.util.List<RegionGroup> list) Set the list of 'RegionPref' element items.
void	setResponseGroup(ResponseGroup responseGroup) Set the 'ResponseGroup' attributeGroup value.
void	setSailingDateRangeDateTimeSpan(DateTimeSpan sailingDateRangeDateTimeSpan) Set the extension value.
void	setSailingDateRangeListOfDurations(java.lang.String sailingDateRangeListOfDurations) Set the 'ListOfDurations' attribute value.
void	setSailingDateRangeMaxDuration(java.lang.String sailingDateRangeMaxDuration) Set the 'MaxDuration' attribute value.
void	setSailingDateRangeMinDuration(java.lang.String sailingDateRangeMinDuration) Set the 'MinDuration' attribute value.
void	setTPAExtensions(TPAExtensions TPAExtensions) Set the 'TPA_Extensions' element value.
int	sizeGuests() Get the number of 'Guest' element items.
int	sizeRegionPrefs() Get the number of 'RegionPref' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

SailAvailRQ

public SailAvailRQ()

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 SailAvailRQ.GuestCounts getGuestCounts()

Get the 'GuestCounts' element value.

Returns:

value

setGuestCounts

public void setGuestCounts(SailAvailRQ.GuestCounts guestCounts)

Set the 'GuestCounts' element value.

Parameters:

guestCounts -

getSailingDateRangeDateTimeSpan

public DateTimeSpan getSailingDateRangeDateTimeSpan()

Get the extension value.

Returns:

value

setSailingDateRangeDateTimeSpan

public void setSailingDateRangeDateTimeSpan(DateTimeSpan sailingDateRangeDateTimeSpan)

Set the extension value.

Parameters:

sailingDateRangeDateTimeSpan -

getSailingDateRangeMinDuration

public java.lang.String getSailingDateRangeMinDuration()

Get the 'MinDuration' attribute value. The shortest duration for the search.

Returns:

value

setSailingDateRangeMinDuration

public void setSailingDateRangeMinDuration(java.lang.String sailingDateRangeMinDuration)

Set the 'MinDuration' attribute value. The shortest duration for the search.

Parameters:

sailingDateRangeMinDuration -

getSailingDateRangeMaxDuration

public java.lang.String getSailingDateRangeMaxDuration()

Get the 'MaxDuration' attribute value. The longest duration for the search.

Returns:

value

setSailingDateRangeMaxDuration

public void setSailingDateRangeMaxDuration(java.lang.String sailingDateRangeMaxDuration)

Set the 'MaxDuration' attribute value. The longest duration for the search.

Parameters:

sailingDateRangeMaxDuration -

getSailingDateRangeListOfDurations

public java.lang.String getSailingDateRangeListOfDurations()

Get the 'ListOfDurations' attribute value. A list of individual durations to be included in the response.

Returns:

value

setSailingDateRangeListOfDurations

public void setSailingDateRangeListOfDurations(java.lang.String sailingDateRangeListOfDurations)

Set the 'ListOfDurations' attribute value. A list of individual durations to be included in the response.

Parameters:

sailingDateRangeListOfDurations -

getCruiseLinePrefs

public SailAvailRQ.CruiseLinePrefs getCruiseLinePrefs()

Get the 'CruiseLinePrefs' element value.

Returns:

value

setCruiseLinePrefs

public void setCruiseLinePrefs(SailAvailRQ.CruiseLinePrefs cruiseLinePrefs)

Set the 'CruiseLinePrefs' element value.

Parameters:

cruiseLinePrefs -

getRegionPrefs

public java.util.List<RegionGroup> getRegionPrefs()

Get the list of 'RegionPref' element items. Specifies geographical region to include in the response.

Returns:

list

setRegionPrefs

public void setRegionPrefs(java.util.List<RegionGroup> list)

Set the list of 'RegionPref' element items. Specifies geographical region to include in the response.

Parameters:

list -

sizeRegionPrefs

public int sizeRegionPrefs()

Get the number of 'RegionPref' element items.

Returns:

count

addRegionPref

public void addRegionPref(RegionGroup item)

Add a 'RegionPref' element item.

Parameters:

item -

getRegionPref

public RegionGroup getRegionPref(int index)

Get 'RegionPref' element item by position.

Parameters:

index -

Returns:

item

clearRegionPrefs

public void clearRegionPrefs()

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

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 -