org.ota.cruise
Class FareAvailRS

java.lang.Object
  org.ota.cruise.FareAvailRS

public class FareAvailRS
extends java.lang.Object

The Fare Availability Response message contains fares availability for a given sailing with a specific Mode of Transportation/GatewayCity pair and currency. For each fare the following information may be returned: - Fare Code - Status code - First and second dining services status - Fare indicator - Alternate available modes of transportation - Alternate available currencies - Cruise package information - Group Code This message does not return fare amounts. Fare availability returns the different fare codes that the cruise line uses to group categories. Examples of fare codes are "best fare" or "past passenger fare." 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_CruiseFareAvailRS">
   <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:SailingType" name="SailingInfo" minOccurs="0"/>
         <xs:element name="AlternateCurrencyList" minOccurs="0" maxOccurs="5">
           <xs:complexType>
             <xs:attributeGroup ref="ns:CurrencyCodeGroup"/>
           </xs:complexType>
         </xs:element>
         <xs:element name="FareCodeOptions" minOccurs="0">
           <!-- Reference to inner class FareCodeOptions -->
         </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

FareAvailRS.FareCodeOptions Specifies the different fare options available for the selected sailing.

Constructor Summary

FareAvailRS()

Method Summary

void	addAlternateCurrencyList(CurrencyCodeGroup item) Add a 'AlternateCurrencyList' element item.
void	clearAlternateCurrencyLists() Remove all 'AlternateCurrencyList' element items.
void	clearChoiceSelect() Clear the choice selection.
CurrencyCodeGroup	getAlternateCurrencyList(int index) Get 'AlternateCurrencyList' element item by position.
java.util.List<CurrencyCodeGroup>	getAlternateCurrencyLists() Get the list of 'AlternateCurrencyList' element items.
Errors	getErrors() Get the 'Errors' element value.
FareAvailRS.FareCodeOptions	getFareCodeOptions() Get the 'FareCodeOptions' element value.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
ResponseGroup	getResponseGroup() Get the 'ResponseGroup' attributeGroup value.
Sailing	getSailingInfo() Get the 'SailingInfo' element 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	setAlternateCurrencyLists(java.util.List<CurrencyCodeGroup> list) Set the list of 'AlternateCurrencyList' element items.
void	setErrors(Errors errors) Set the 'Errors' element value.
void	setFareCodeOptions(FareAvailRS.FareCodeOptions fareCodeOptions) Set the 'FareCodeOptions' element value.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setResponseGroup(ResponseGroup responseGroup) Set the 'ResponseGroup' attributeGroup value.
void	setSailingInfo(Sailing sailingInfo) Set the 'SailingInfo' element value.
void	setTPAExtensions(TPAExtensions TPAExtensions) Set the 'TPA_Extensions' element value.
void	setWarnings(Warnings warnings) Set the 'Warnings' element value.
int	sizeAlternateCurrencyLists() Get the number of 'AlternateCurrencyList' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

FareAvailRS

public FareAvailRS()

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 Sailing getSailingInfo()

Get the 'SailingInfo' element value. Specifies the selected sailing information.

Returns:

value

setSailingInfo

public void setSailingInfo(Sailing sailingInfo)

Set the 'SailingInfo' element value. Specifies the selected sailing information.

Parameters:

sailingInfo -

getAlternateCurrencyLists

public java.util.List<CurrencyCodeGroup> getAlternateCurrencyLists()

Get the list of 'AlternateCurrencyList' element items. Other available currencies for this sailing.

Returns:

list

setAlternateCurrencyLists

public void setAlternateCurrencyLists(java.util.List<CurrencyCodeGroup> list)

Set the list of 'AlternateCurrencyList' element items. Other available currencies for this sailing.

Parameters:

list -

sizeAlternateCurrencyLists

public int sizeAlternateCurrencyLists()

Get the number of 'AlternateCurrencyList' element items.

Returns:

count

addAlternateCurrencyList

public void addAlternateCurrencyList(CurrencyCodeGroup item)

Add a 'AlternateCurrencyList' element item.

Parameters:

item -

getAlternateCurrencyList

public CurrencyCodeGroup getAlternateCurrencyList(int index)

Get 'AlternateCurrencyList' element item by position.

Parameters:

index -

Returns:

item

clearAlternateCurrencyLists

public void clearAlternateCurrencyLists()

Remove all 'AlternateCurrencyList' element items.

getFareCodeOptions

public FareAvailRS.FareCodeOptions getFareCodeOptions()

Get the 'FareCodeOptions' element value.

Returns:

value

setFareCodeOptions

public void setFareCodeOptions(FareAvailRS.FareCodeOptions fareCodeOptions)

Set the 'FareCodeOptions' element value.

Parameters:

fareCodeOptions -

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 -