org.ota.hotel
Class RatePlanRS

java.lang.Object
  org.ota.hotel.RatePlanRS

public class RatePlanRS
extends java.lang.Object

Returns information about hotel rate plans that meet the requested criteria. 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_HotelRatePlanRS">
   <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="RatePlans">
           <xs:complexType>
             <xs:sequence>
               <xs:element type="ns:HotelRatePlanType" name="RatePlan" maxOccurs="unbounded"/>
             </xs:sequence>
             <xs:attributeGroup ref="ns:HotelReferenceGroup"/>
           </xs:complexType>
         </xs:element>
         <xs:element name="Offers" minOccurs="0">
           <!-- Reference to inner class Offers -->
         </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:attribute type="xs:string" use="optional" name="MessageContentCode"/>
   </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

RatePlanRS.Offers A collection of offers that apply to all of the rate plans.

Constructor Summary

RatePlanRS()

Method Summary

void	addRatePlansRatePlan(HotelRatePlan item) Add a 'RatePlan' element item.
void	clearChoiceSelect() Clear the choice selection.
void	clearRatePlansRatePlans() Remove all 'RatePlan' element items.
Errors	getErrors() Get the 'Errors' element value.
java.lang.String	getMessageContentCode() Get the 'MessageContentCode' attribute value.
RatePlanRS.Offers	getOffers() Get the 'Offers' element value.
OTAPayloadStdAttributes	getOTAPayloadStdAttributes() Get the 'OTA_PayloadStdAttributes' attributeGroup value.
HotelReferenceGroup	getRatePlansHotelReferenceGroup() Get the 'HotelReferenceGroup' attributeGroup value.
HotelRatePlan	getRatePlansRatePlan(int index) Get 'RatePlan' element item by position.
java.util.List<HotelRatePlan>	getRatePlansRatePlans() Get the list of 'RatePlan' element items.
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	setErrors(Errors errors) Set the 'Errors' element value.
void	setMessageContentCode(java.lang.String messageContentCode) Set the 'MessageContentCode' attribute value.
void	setOffers(RatePlanRS.Offers offers) Set the 'Offers' element value.
void	setOTAPayloadStdAttributes(OTAPayloadStdAttributes OTAPayloadStdAttributes) Set the 'OTA_PayloadStdAttributes' attributeGroup value.
void	setRatePlansHotelReferenceGroup(HotelReferenceGroup ratePlansHotelReferenceGroup) Set the 'HotelReferenceGroup' attributeGroup value.
void	setRatePlansRatePlans(java.util.List<HotelRatePlan> list) Set the list of 'RatePlan' element items.
void	setTPAExtensions(TPAExtensions TPAExtensions) Set the 'TPA_Extensions' element value.
void	setWarnings(Warnings warnings) Set the 'Warnings' element value.
int	sizeRatePlansRatePlans() Get the number of 'RatePlan' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

RatePlanRS

public RatePlanRS()

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. Used in conjunction with the Success element to define one or more business errors.

Returns:

value

setWarnings

public void setWarnings(Warnings warnings)

Set the 'Warnings' element value. Used in conjunction with the Success element to define one or more business errors.

Parameters:

warnings -

getRatePlansRatePlans

public java.util.List<HotelRatePlan> getRatePlansRatePlans()

Get the list of 'RatePlan' element items. An individual rate plan.

Returns:

list

setRatePlansRatePlans

public void setRatePlansRatePlans(java.util.List<HotelRatePlan> list)

Set the list of 'RatePlan' element items. An individual rate plan.

Parameters:

list -

sizeRatePlansRatePlans

public int sizeRatePlansRatePlans()

Get the number of 'RatePlan' element items.

Returns:

count

addRatePlansRatePlan

public void addRatePlansRatePlan(HotelRatePlan item)

Add a 'RatePlan' element item.

Parameters:

item -

getRatePlansRatePlan

public HotelRatePlan getRatePlansRatePlan(int index)

Get 'RatePlan' element item by position.

Parameters:

index -

Returns:

item

clearRatePlansRatePlans

public void clearRatePlansRatePlans()

Remove all 'RatePlan' element items.

getRatePlansHotelReferenceGroup

public HotelReferenceGroup getRatePlansHotelReferenceGroup()

Get the 'HotelReferenceGroup' attributeGroup value.

Returns:

value

setRatePlansHotelReferenceGroup

public void setRatePlansHotelReferenceGroup(HotelReferenceGroup ratePlansHotelReferenceGroup)

Set the 'HotelReferenceGroup' attributeGroup value.

Parameters:

ratePlansHotelReferenceGroup -

getOffers

public RatePlanRS.Offers getOffers()

Get the 'Offers' element value.

Returns:

value

setOffers

public void setOffers(RatePlanRS.Offers offers)

Set the 'Offers' element value.

Parameters:

offers -

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. Errors are returned if the request was unable to be processed.

Returns:

value

setErrors

public void setErrors(Errors errors)

Set the 'Errors' element value. Errors are returned if the request was unable to be processed.

Parameters:

errors -

getOTAPayloadStdAttributes

public OTAPayloadStdAttributes getOTAPayloadStdAttributes()

Get the 'OTA_PayloadStdAttributes' attributeGroup value. This element defines 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. This element defines standard attributes that appear on the root element for all OpenTravel Messages.

Parameters:

OTAPayloadStdAttributes -

getMessageContentCode

public java.lang.String getMessageContentCode()

Get the 'MessageContentCode' attribute value. Defines specific content of the message being sent. Refer to OpenTravel Code List TDB.

Returns:

value

setMessageContentCode

public void setMessageContentCode(java.lang.String messageContentCode)

Set the 'MessageContentCode' attribute value. Defines specific content of the message being sent. Refer to OpenTravel Code List TDB.

Parameters:

messageContentCode -