org.ota.cruise
Class BookRS

java.lang.Object
  org.ota.cruise.BookRS

public class BookRS
extends java.lang.Object

The book response message contains booking information for a given sailing with a specific mode of transportation/gateway city pair and currency and for a selected fare/category pair. This message contains similar information to a standard airline CRS or GDS sailing availability response message. 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_CruiseBookRS">
   <xs:complexType>
     <xs:choice>
       <xs:sequence>
         <xs:element type="ns:SuccessType" name="Success"/>
         <xs:element type="ns:WarningsType" name="Warnings" minOccurs="0"/>
         <xs:element name="ReservationID" minOccurs="0" maxOccurs="2">
           <!-- Reference to inner class ReservationID -->
         </xs:element>
         <xs:element type="ns:SailingCategoryInfoType" name="SailingInfo" minOccurs="0"/>
         <xs:element type="ns:ParagraphType" name="PolicyInfo" minOccurs="0" maxOccurs="5"/>
         <xs:element type="ns:CruiseBookingInfoType" name="BookingPayment" minOccurs="0"/>
       </xs:sequence>
       <xs:element type="ns:ErrorsType" name="Errors"/>
     </xs:choice>
     <xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
   </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

BookRS.ReservationID Specifies the reservation control information or the guest's booking ID in modification mode (e.g.

Constructor Summary

BookRS()

Method Summary

void	addPolicyInfo(Paragraph item) Add a 'PolicyInfo' element item.
void	addReservationID(BookRS.ReservationID item) Add a 'ReservationID' element item.
void	clearChoiceSelect() Clear the choice selection.
void	clearPolicyInfos() Remove all 'PolicyInfo' element items.
void	clearReservationIDs() Remove all 'ReservationID' element items.
CruiseBookingInfo	getBookingPayment() Get the 'BookingPayment' element value.
Errors	getErrors() Get the 'Errors' element value.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
Paragraph	getPolicyInfo(int index) Get 'PolicyInfo' element item by position.
java.util.List<Paragraph>	getPolicyInfos() Get the list of 'PolicyInfo' element items.
BookRS.ReservationID	getReservationID(int index) Get 'ReservationID' element item by position.
java.util.List<BookRS.ReservationID>	getReservationIDs() Get the list of 'ReservationID' element items.
SailingCategoryInfo	getSailingInfo() Get the 'SailingInfo' 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	setBookingPayment(CruiseBookingInfo bookingPayment) Set the 'BookingPayment' element value.
void	setErrors(Errors errors) Set the 'Errors' element value.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setPolicyInfos(java.util.List<Paragraph> list) Set the list of 'PolicyInfo' element items.
void	setReservationIDs(java.util.List<BookRS.ReservationID> list) Set the list of 'ReservationID' element items.
void	setSailingInfo(SailingCategoryInfo sailingInfo) Set the 'SailingInfo' element value.
void	setWarnings(Warnings warnings) Set the 'Warnings' element value.
int	sizePolicyInfos() Get the number of 'PolicyInfo' element items.
int	sizeReservationIDs() Get the number of 'ReservationID' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

BookRS

public BookRS()

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 -

getReservationIDs

public java.util.List<BookRS.ReservationID> getReservationIDs()

Get the list of 'ReservationID' element items.

Returns:

list

setReservationIDs

public void setReservationIDs(java.util.List<BookRS.ReservationID> list)

Set the list of 'ReservationID' element items.

Parameters:

list -

sizeReservationIDs

public int sizeReservationIDs()

Get the number of 'ReservationID' element items.

Returns:

count

addReservationID

public void addReservationID(BookRS.ReservationID item)

Add a 'ReservationID' element item.

Parameters:

item -

getReservationID

public BookRS.ReservationID getReservationID(int index)

Get 'ReservationID' element item by position.

Parameters:

index -

Returns:

item

clearReservationIDs

public void clearReservationIDs()

Remove all 'ReservationID' element items.

getSailingInfo

public SailingCategoryInfo getSailingInfo()

Get the 'SailingInfo' element value. Specifies the selected category to book.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(SailingCategoryInfo sailingInfo)

Set the 'SailingInfo' element value. Specifies the selected category to book.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 -

getPolicyInfos

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

Get the list of 'PolicyInfo' element items. May be used to provide policy information regarding the booking.

Returns:

list

setPolicyInfos

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

Set the list of 'PolicyInfo' element items. May be used to provide policy information regarding the booking.

Parameters:

list -

sizePolicyInfos

public int sizePolicyInfos()

Get the number of 'PolicyInfo' element items.

Returns:

count

addPolicyInfo

public void addPolicyInfo(Paragraph item)

Add a 'PolicyInfo' element item.

Parameters:

item -

getPolicyInfo

public Paragraph getPolicyInfo(int index)

Get 'PolicyInfo' element item by position.

Parameters:

index -

Returns:

item

clearPolicyInfos

public void clearPolicyInfos()

Remove all 'PolicyInfo' element items.

getBookingPayment

public CruiseBookingInfo getBookingPayment()

Get the 'BookingPayment' element value. Specifies pricing and payment information about the booking.

Returns:

value

setBookingPayment

public void setBookingPayment(CruiseBookingInfo bookingPayment)

Set the 'BookingPayment' element value. Specifies pricing and payment information about the booking.

Parameters:

bookingPayment -

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 -