org.ota.cruise
Class CategoryAvailRS

java.lang.Object
  org.ota.cruise.CategoryAvailRS

public class CategoryAvailRS
extends java.lang.Object

The Category Availability Response message contains category availability for a given sailing with a specific Mode of Transportation/GatewayCity pair and currency for 1 to multiple fares (depending on the cruise line). For each category the following information may be returned: - Berthed category code - Priced category code - Status code - Category indicator - Cruise package information - Group code - Fare code - Currency code This message returns the fare amounts available in the different categories. At this point in the process the customer has selected the fare code and has queried the different category offerings for that fare code. 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_CruiseCategoryAvailRS">
   <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:SailingInfoType" name="SailingInfo"/>
         <xs:element name="FareOption" minOccurs="0" maxOccurs="5">
           <!-- Reference to inner class FareOption -->
         </xs:element>
         <xs:element type="ns:TaxesType" name="Taxes" minOccurs="0"/>
         <xs:element type="ns:FeeType" name="Fee" minOccurs="0" maxOccurs="3"/>
         <xs:element type="ns:ParagraphType" name="Information" minOccurs="0" maxOccurs="5"/>
       </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"/>
 

Nested Class Summary

static class

CategoryAvailRS.FareOption Fare and associated categories information.

Constructor Summary

CategoryAvailRS()

Method Summary

void	addFareOption(CategoryAvailRS.FareOption item) Add a 'FareOption' element item.
void	addFee(Fee item) Add a 'Fee' element item.
void	addInformation(Paragraph item) Add a 'Information' element item.
void	clearChoiceSelect() Clear the choice selection.
void	clearFareOptions() Remove all 'FareOption' element items.
void	clearFees() Remove all 'Fee' element items.
void	clearInformations() Remove all 'Information' element items.
Errors	getErrors() Get the 'Errors' element value.
CategoryAvailRS.FareOption	getFareOption(int index) Get 'FareOption' element item by position.
java.util.List<CategoryAvailRS.FareOption>	getFareOptions() Get the list of 'FareOption' element items.
Fee	getFee(int index) Get 'Fee' element item by position.
java.util.List<Fee>	getFees() Get the list of 'Fee' element items.
Paragraph	getInformation(int index) Get 'Information' element item by position.
java.util.List<Paragraph>	getInformations() Get the list of 'Information' element items.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
ResponseGroup	getResponseGroup() Get the 'ResponseGroup' attributeGroup value.
SailingInfo	getSailingInfo() Get the 'SailingInfo' element value.
Taxes	getTaxes() Get the 'Taxes' 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	setErrors(Errors errors) Set the 'Errors' element value.
void	setFareOptions(java.util.List<CategoryAvailRS.FareOption> list) Set the list of 'FareOption' element items.
void	setFees(java.util.List<Fee> list) Set the list of 'Fee' element items.
void	setInformations(java.util.List<Paragraph> list) Set the list of 'Information' element items.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setResponseGroup(ResponseGroup responseGroup) Set the 'ResponseGroup' attributeGroup value.
void	setSailingInfo(SailingInfo sailingInfo) Set the 'SailingInfo' element value.
void	setTaxes(Taxes taxes) Set the 'Taxes' element value.
void	setWarnings(Warnings warnings) Set the 'Warnings' element value.
int	sizeFareOptions() Get the number of 'FareOption' element items.
int	sizeFees() Get the number of 'Fee' element items.
int	sizeInformations() Get the number of 'Information' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoryAvailRS

public CategoryAvailRS()

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

Get the 'SailingInfo' element value. Requested sailing information. Currency in which the fares are being returned. Specifies the available inclusive package.

Returns:

value

setSailingInfo

public void setSailingInfo(SailingInfo sailingInfo)

Set the 'SailingInfo' element value. Requested sailing information. Currency in which the fares are being returned. Specifies the available inclusive package.

Parameters:

sailingInfo -

getFareOptions

public java.util.List<CategoryAvailRS.FareOption> getFareOptions()

Get the list of 'FareOption' element items.

Returns:

list

setFareOptions

public void setFareOptions(java.util.List<CategoryAvailRS.FareOption> list)

Set the list of 'FareOption' element items.

Parameters:

list -

sizeFareOptions

public int sizeFareOptions()

Get the number of 'FareOption' element items.

Returns:

count

addFareOption

public void addFareOption(CategoryAvailRS.FareOption item)

Add a 'FareOption' element item.

Parameters:

item -

getFareOption

public CategoryAvailRS.FareOption getFareOption(int index)

Get 'FareOption' element item by position.

Parameters:

index -

Returns:

item

clearFareOptions

public void clearFareOptions()

Remove all 'FareOption' element items.

getTaxes

public Taxes getTaxes()

Get the 'Taxes' element value. Collection of cruise taxes.

Returns:

value

setTaxes

public void setTaxes(Taxes taxes)

Set the 'Taxes' element value. Collection of cruise taxes.

Parameters:

taxes -

getFees

public java.util.List<Fee> getFees()

Get the list of 'Fee' element items. Specifies additional charges. (e.g., port charges, port services fee).

Returns:

list

setFees

public void setFees(java.util.List<Fee> list)

Set the list of 'Fee' element items. Specifies additional charges. (e.g., port charges, port services fee).

Parameters:

list -

sizeFees

public int sizeFees()

Get the number of 'Fee' element items.

Returns:

count

addFee

public void addFee(Fee item)

Add a 'Fee' element item.

Parameters:

item -

getFee

public Fee getFee(int index)

Get 'Fee' element item by position.

Parameters:

index -

Returns:

item

clearFees

public void clearFees()

Remove all 'Fee' element items.

getInformations

public java.util.List<Paragraph> getInformations()

Get the list of 'Information' element items. Advisory information returned by the cruise line.

Returns:

list

setInformations

public void setInformations(java.util.List<Paragraph> list)

Set the list of 'Information' element items. Advisory information returned by the cruise line.

Parameters:

list -

sizeInformations

public int sizeInformations()

Get the number of 'Information' element items.

Returns:

count

addInformation

public void addInformation(Paragraph item)

Add a 'Information' element item.

Parameters:

item -

getInformation

public Paragraph getInformation(int index)

Get 'Information' element item by position.

Parameters:

index -

Returns:

item

clearInformations

public void clearInformations()

Remove all 'Information' element items.

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 -