org.ota.dynamicpkg
Class AvailRS.SearchResults.HotelResults.RoomStays.RoomStay

java.lang.Object
  org.ota.hotel.RoomStay
      org.ota.dynamicpkg.AvailRS.SearchResults.HotelResults.RoomStays.RoomStay

Enclosing class:

AvailRS.SearchResults.HotelResults.RoomStays

public static class AvailRS.SearchResults.HotelResults.RoomStays.RoomStay
extends RoomStay

Details on the Room Stay including Guest Counts, Time Span of this Room Stay, and financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. 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="RoomStay" maxOccurs="unbounded">
   <xs:complexType>
     <xs:complexContent>
       <xs:extension base="ns:RoomStayType">
         <xs:sequence>
           <xs:element name="Reference" minOccurs="0">
             <!-- Reference to inner class Reference -->
           </xs:element>
           <xs:element type="ns:ServiceRPHsType" name="ServiceRPHs" minOccurs="0"/>
         </xs:sequence>
         <xs:attribute type="xs:boolean" use="optional" name="IsAlternate"/>
         <xs:attribute type="ns:RateIndicatorType" use="optional" name="AvailabilityStatus"/>
         <xs:attributeGroup ref="ns:ResponseTypeGroup"/>
         <xs:attribute type="xs:string" use="optional" name="RoomStayCandidateRPH"/>
         <xs:attribute type="xs:string" use="optional" name="MoreDataEchoToken"/>
         <xs:attribute type="xs:string" use="optional" name="InfoSource"/>
         <xs:attribute type="xs:string" use="optional" name="RPH"/>
         <xs:attribute type="xs:boolean" use="optional" name="AvailableIndicator"/>
       </xs:extension>
     </xs:complexContent>
   </xs:complexType>
 </xs:element>
 

Nested Class Summary

static class

AvailRS.SearchResults.HotelResults.RoomStays.RoomStay.Reference Information by which this availability quote can be later cross-referenced.

Nested classes/interfaces inherited from class org.ota.hotel.RoomStay

RoomStay.RatePlans, RoomStay.RoomRates, RoomStay.RoomTypes

Constructor Summary

AvailRS.SearchResults.HotelResults.RoomStays.RoomStay()

Method Summary

RateIndicator	getAvailabilityStatus() Get the 'AvailabilityStatus' attribute value.
java.lang.Boolean	getAvailableIndicator() Get the 'AvailableIndicator' attribute value.
java.lang.String	getInfoSource() Get the 'InfoSource' attribute value.
java.lang.Boolean	getIsAlternate() Get the 'IsAlternate' attribute value.
java.lang.String	getMoreDataEchoToken() Get the 'MoreDataEchoToken' attribute value.
AvailRS.SearchResults.HotelResults.RoomStays.RoomStay.Reference	getReference() Get the 'Reference' element value.
ResponseTypeGroup	getResponseTypeGroup() Get the 'ResponseTypeGroup' attributeGroup value.
java.lang.String	getRoomStayCandidateRPH() Get the 'RoomStayCandidateRPH' attribute value.
java.lang.String	getRPH() Get the 'RPH' attribute value.
ServiceRPHs	getServiceRPHs() Get the 'ServiceRPHs' element value.
void	setAvailabilityStatus(RateIndicator availabilityStatus) Set the 'AvailabilityStatus' attribute value.
void	setAvailableIndicator(java.lang.Boolean availableIndicator) Set the 'AvailableIndicator' attribute value.
void	setInfoSource(java.lang.String infoSource) Set the 'InfoSource' attribute value.
void	setIsAlternate(java.lang.Boolean isAlternate) Set the 'IsAlternate' attribute value.
void	setMoreDataEchoToken(java.lang.String moreDataEchoToken) Set the 'MoreDataEchoToken' attribute value.
void	setReference(AvailRS.SearchResults.HotelResults.RoomStays.RoomStay.Reference reference) Set the 'Reference' element value.
void	setResponseTypeGroup(ResponseTypeGroup responseTypeGroup) Set the 'ResponseTypeGroup' attributeGroup value.
void	setRoomStayCandidateRPH(java.lang.String roomStayCandidateRPH) Set the 'RoomStayCandidateRPH' attribute value.
void	setRPH(java.lang.String RPH) Set the 'RPH' attribute value.
void	setServiceRPHs(ServiceRPHs serviceRPHs) Set the 'ServiceRPHs' element value.

Methods inherited from class org.ota.hotel.RoomStay

addGuarantee, clearGuarantees, getBasicPropertyInfo, getCancelPenalties, getDepositPayments, getDiscount, getDiscountCode, getGuarantee, getGuarantees, getGuestCounts, getMarketCode, getPromotionCodeGroup, getRatePlans, getRoomRates, getRoomStayStatus, getRoomTypes, getSourceOfBusiness, getTimeSpan, getTotal, getTPAExtensions, getWarningRPH, setBasicPropertyInfo, setCancelPenalties, setDepositPayments, setDiscount, setDiscountCode, setGuarantees, setGuestCounts, setMarketCode, setPromotionCodeGroup, setRatePlans, setRoomRates, setRoomStayStatus, setRoomTypes, setSourceOfBusiness, setTimeSpan, setTotal, setTPAExtensions, setWarningRPH, sizeGuarantees

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailRS.SearchResults.HotelResults.RoomStays.RoomStay

public AvailRS.SearchResults.HotelResults.RoomStays.RoomStay()

Method Detail

getReference

public AvailRS.SearchResults.HotelResults.RoomStays.RoomStay.Reference getReference()

Get the 'Reference' element value.

Returns:

value

setReference

public void setReference(AvailRS.SearchResults.HotelResults.RoomStays.RoomStay.Reference reference)

Set the 'Reference' element value.

Parameters:

reference -

getServiceRPHs

public ServiceRPHs getServiceRPHs()

Get the 'ServiceRPHs' element value. A container for the unique references to the services for the room stay.

Returns:

value

setServiceRPHs

public void setServiceRPHs(ServiceRPHs serviceRPHs)

Set the 'ServiceRPHs' element value. A container for the unique references to the services for the room stay.

Parameters:

serviceRPHs -

getIsAlternate

public java.lang.Boolean getIsAlternate()

Get the 'IsAlternate' attribute value. Indicates the RoomStay is an alternate offer. Default=false. false

Returns:

value

setIsAlternate

public void setIsAlternate(java.lang.Boolean isAlternate)

Set the 'IsAlternate' attribute value. Indicates the RoomStay is an alternate offer. Default=false. false

Parameters:

isAlternate -

getAvailabilityStatus

public RateIndicator getAvailabilityStatus()

Get the 'AvailabilityStatus' attribute value. Used to specify an availability status at the room stay level for a property.

Returns:

value

setAvailabilityStatus

public void setAvailabilityStatus(RateIndicator availabilityStatus)

Set the 'AvailabilityStatus' attribute value. Used to specify an availability status at the room stay level for a property.

Parameters:

availabilityStatus -

getResponseTypeGroup

public ResponseTypeGroup getResponseTypeGroup()

Get the 'ResponseTypeGroup' attributeGroup value. Indicates the type of data to be returned, either a list of hotel records or a list of area (city/reference) codes.

Returns:

value

setResponseTypeGroup

public void setResponseTypeGroup(ResponseTypeGroup responseTypeGroup)

Set the 'ResponseTypeGroup' attributeGroup value. Indicates the type of data to be returned, either a list of hotel records or a list of area (city/reference) codes.

Parameters:

responseTypeGroup -

getRoomStayCandidateRPH

public java.lang.String getRoomStayCandidateRPH()

Get the 'RoomStayCandidateRPH' attribute value. A reference to a requested room stay candidate from the SearchCriteria.

Returns:

value

setRoomStayCandidateRPH

public void setRoomStayCandidateRPH(java.lang.String roomStayCandidateRPH)

Set the 'RoomStayCandidateRPH' attribute value. A reference to a requested room stay candidate from the SearchCriteria.

Parameters:

roomStayCandidateRPH -

getMoreDataEchoToken

public java.lang.String getMoreDataEchoToken()

Get the 'MoreDataEchoToken' attribute value. The availability response returns the attribute if there is additional data that could not fit within the availability response. The text value should be echoed in the availability request to indicate where to begin the next block of availability data.

Returns:

value

setMoreDataEchoToken

public void setMoreDataEchoToken(java.lang.String moreDataEchoToken)

Set the 'MoreDataEchoToken' attribute value. The availability response returns the attribute if there is additional data that could not fit within the availability response. The text value should be echoed in the availability request to indicate where to begin the next block of availability data.

Parameters:

moreDataEchoToken -

getInfoSource

public java.lang.String getInfoSource()

Get the 'InfoSource' attribute value. Used to specify the source of the data being exchanged as determined by trading partners.

Returns:

value

setInfoSource

public void setInfoSource(java.lang.String infoSource)

Set the 'InfoSource' attribute value. Used to specify the source of the data being exchanged as determined by trading partners.

Parameters:

infoSource -

getRPH

public java.lang.String getRPH()

Get the 'RPH' attribute value. Identifies the room stay for use in the hotel stay.

Returns:

value

setRPH

public void setRPH(java.lang.String RPH)

Set the 'RPH' attribute value. Identifies the room stay for use in the hotel stay.

Parameters:

RPH -

getAvailableIndicator

public java.lang.Boolean getAvailableIndicator()

Get the 'AvailableIndicator' attribute value. May be used as a simple true/false to indicate availability or used in conjunction with @AvailabilityStatus to indicate if restricted rate qualifications have been met e.g. Exclusive and Available (true) vs. Exclusive but not Available (false).

Returns:

value

setAvailableIndicator

public void setAvailableIndicator(java.lang.Boolean availableIndicator)

Set the 'AvailableIndicator' attribute value. May be used as a simple true/false to indicate availability or used in conjunction with @AvailabilityStatus to indicate if restricted rate qualifications have been met e.g. Exclusive and Available (true) vs. Exclusive but not Available (false).

Parameters:

availableIndicator -