org.ota.hotel
Class RoomStay

java.lang.Object
  org.ota.hotel.RoomStay

Direct Known Subclasses:

AvailRS.RoomStays.RoomStay, AvailRS.SearchResults.HotelResults.RoomStays.RoomStay, HotelReservation.RoomStays.RoomStay, HotelRoomList.RoomStays.RoomStay

public class RoomStay
extends java.lang.Object

Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally finacial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="RoomStayType">
   <xs:sequence>
     <xs:element name="RoomTypes" minOccurs="0">
       <!-- Reference to inner class RoomTypes -->
     </xs:element>
     <xs:element name="RatePlans" minOccurs="0">
       <!-- Reference to inner class RatePlans -->
     </xs:element>
     <xs:element name="RoomRates" minOccurs="0">
       <!-- Reference to inner class RoomRates -->
     </xs:element>
     <xs:element type="ns:GuestCountType" name="GuestCounts" minOccurs="0"/>
     <xs:element type="ns:DateTimeSpanType" name="TimeSpan" minOccurs="0"/>
     <xs:element type="ns:GuaranteeType" name="Guarantee" minOccurs="0" maxOccurs="5"/>
     <xs:element type="ns:RequiredPaymentsType" name="DepositPayments" minOccurs="0"/>
     <xs:element type="ns:CancelPenaltiesType" name="CancelPenalties" minOccurs="0"/>
     <xs:element type="ns:DiscountType" name="Discount" minOccurs="0"/>
     <xs:element type="ns:TotalType" name="Total" minOccurs="0"/>
     <xs:element type="ns:BasicPropertyInfoType" name="BasicPropertyInfo" minOccurs="0"/>
     <xs:element ref="ns:TPA_Extensions" minOccurs="0"/>
   </xs:sequence>
   <xs:attribute type="xs:string" use="optional" name="MarketCode"/>
   <xs:attribute type="xs:string" use="optional" name="SourceOfBusiness"/>
   <xs:attribute type="xs:string" use="optional" name="DiscountCode"/>
   <xs:attributeGroup ref="ns:PromotionCodeGroup"/>
   <xs:attribute type="xs:string" use="optional" name="RoomStayStatus"/>
   <xs:attribute type="xs:string" use="optional" name="WarningRPH"/>
 </xs:complexType>
 
 <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	RoomStay.RatePlans A collection of Rate Plans associated with a particular Room Stay.The rate plan element is used to contain all the rate information for a single Rate Plan Code (ex RACK) for a given date range.
static class	RoomStay.RoomRates A collection of Room Rates associated with a particular Room Stay.
static class	RoomStay.RoomTypes A collection of Room Types associated with a particular Room Stay.The RoomType element is used to contain all the room type information for a single RateType Code (ex A1K) for a given date range.

Constructor Summary

RoomStay()

Method Summary

void	addGuarantee(Guarantee item) Add a 'Guarantee' element item.
void	clearGuarantees() Remove all 'Guarantee' element items.
BasicPropertyInfo	getBasicPropertyInfo() Get the 'BasicPropertyInfo' element value.
CancelPenalties	getCancelPenalties() Get the 'CancelPenalties' element value.
RequiredPayments	getDepositPayments() Get the 'DepositPayments' element value.
Discount	getDiscount() Get the 'Discount' element value.
java.lang.String	getDiscountCode() Get the 'DiscountCode' attribute value.
Guarantee	getGuarantee(int index) Get 'Guarantee' element item by position.
java.util.List<Guarantee>	getGuarantees() Get the list of 'Guarantee' element items.
GuestCount	getGuestCounts() Get the 'GuestCounts' element value.
java.lang.String	getMarketCode() Get the 'MarketCode' attribute value.
PromotionCodeGroup	getPromotionCodeGroup() Get the 'PromotionCodeGroup' attributeGroup value.
RoomStay.RatePlans	getRatePlans() Get the 'RatePlans' element value.
RoomStay.RoomRates	getRoomRates() Get the 'RoomRates' element value.
java.lang.String	getRoomStayStatus() Get the 'RoomStayStatus' attribute value.
RoomStay.RoomTypes	getRoomTypes() Get the 'RoomTypes' element value.
java.lang.String	getSourceOfBusiness() Get the 'SourceOfBusiness' attribute value.
DateTimeSpan	getTimeSpan() Get the 'TimeSpan' element value.
Total	getTotal() Get the 'Total' element value.
TPAExtensions	getTPAExtensions() Get the 'TPA_Extensions' element value.
java.lang.String	getWarningRPH() Get the 'WarningRPH' attribute value.
void	setBasicPropertyInfo(BasicPropertyInfo basicPropertyInfo) Set the 'BasicPropertyInfo' element value.
void	setCancelPenalties(CancelPenalties cancelPenalties) Set the 'CancelPenalties' element value.
void	setDepositPayments(RequiredPayments depositPayments) Set the 'DepositPayments' element value.
void	setDiscount(Discount discount) Set the 'Discount' element value.
void	setDiscountCode(java.lang.String discountCode) Set the 'DiscountCode' attribute value.
void	setGuarantees(java.util.List<Guarantee> list) Set the list of 'Guarantee' element items.
void	setGuestCounts(GuestCount guestCounts) Set the 'GuestCounts' element value.
void	setMarketCode(java.lang.String marketCode) Set the 'MarketCode' attribute value.
void	setPromotionCodeGroup(PromotionCodeGroup promotionCodeGroup) Set the 'PromotionCodeGroup' attributeGroup value.
void	setRatePlans(RoomStay.RatePlans ratePlans) Set the 'RatePlans' element value.
void	setRoomRates(RoomStay.RoomRates roomRates) Set the 'RoomRates' element value.
void	setRoomStayStatus(java.lang.String roomStayStatus) Set the 'RoomStayStatus' attribute value.
void	setRoomTypes(RoomStay.RoomTypes roomTypes) Set the 'RoomTypes' element value.
void	setSourceOfBusiness(java.lang.String sourceOfBusiness) Set the 'SourceOfBusiness' attribute value.
void	setTimeSpan(DateTimeSpan timeSpan) Set the 'TimeSpan' element value.
void	setTotal(Total total) Set the 'Total' element value.
void	setTPAExtensions(TPAExtensions TPAExtensions) Set the 'TPA_Extensions' element value.
void	setWarningRPH(java.lang.String warningRPH) Set the 'WarningRPH' attribute value.
int	sizeGuarantees() Get the number of 'Guarantee' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomStay

public RoomStay()

Method Detail

getRoomTypes

public RoomStay.RoomTypes getRoomTypes()

Get the 'RoomTypes' element value.

Returns:

value

setRoomTypes

public void setRoomTypes(RoomStay.RoomTypes roomTypes)

Set the 'RoomTypes' element value.

Parameters:

roomTypes -

getRatePlans

public RoomStay.RatePlans getRatePlans()

Get the 'RatePlans' element value.

Returns:

value

setRatePlans

public void setRatePlans(RoomStay.RatePlans ratePlans)

Set the 'RatePlans' element value.

Parameters:

ratePlans -

getRoomRates

public RoomStay.RoomRates getRoomRates()

Get the 'RoomRates' element value.

Returns:

value

setRoomRates

public void setRoomRates(RoomStay.RoomRates roomRates)

Set the 'RoomRates' element value.

Parameters:

roomRates -

getGuestCounts

public GuestCount getGuestCounts()

Get the 'GuestCounts' element value. A collection of Guest Counts associated with Room Stay. A child Guest Count element is required for each distinct age group.

Returns:

value

setGuestCounts

public void setGuestCounts(GuestCount guestCounts)

Set the 'GuestCounts' element value. A collection of Guest Counts associated with Room Stay. A child Guest Count element is required for each distinct age group.

Parameters:

guestCounts -

getTimeSpan

public DateTimeSpan getTimeSpan()

Get the 'TimeSpan' element value. The Time Span which covers the Room Stay.

Returns:

value

setTimeSpan

public void setTimeSpan(DateTimeSpan timeSpan)

Set the 'TimeSpan' element value. The Time Span which covers the Room Stay.

Parameters:

timeSpan -

getGuarantees

public java.util.List<Guarantee> getGuarantees()

Get the list of 'Guarantee' element items. The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.

Returns:

list

setGuarantees

public void setGuarantees(java.util.List<Guarantee> list)

Set the list of 'Guarantee' element items. The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.

Parameters:

list -

sizeGuarantees

public int sizeGuarantees()

Get the number of 'Guarantee' element items.

Returns:

count

addGuarantee

public void addGuarantee(Guarantee item)

Add a 'Guarantee' element item.

Parameters:

item -

getGuarantee

public Guarantee getGuarantee(int index)

Get 'Guarantee' element item by position.

Parameters:

index -

Returns:

item

clearGuarantees

public void clearGuarantees()

Remove all 'Guarantee' element items.

getDepositPayments

public RequiredPayments getDepositPayments()

Get the 'DepositPayments' element value. A collection of deposit and/or payments for the Room Stay.

Returns:

value

setDepositPayments

public void setDepositPayments(RequiredPayments depositPayments)

Set the 'DepositPayments' element value. A collection of deposit and/or payments for the Room Stay.

Parameters:

depositPayments -

getCancelPenalties

public CancelPenalties getCancelPenalties()

Get the 'CancelPenalties' element value. A collection of Cancellation Penalties objects for the Room Stay.

Returns:

value

setCancelPenalties

public void setCancelPenalties(CancelPenalties cancelPenalties)

Set the 'CancelPenalties' element value. A collection of Cancellation Penalties objects for the Room Stay.

Parameters:

cancelPenalties -

getDiscount

public Discount getDiscount()

Get the 'Discount' element value. Discount percentage and/or Amount, code and textual reason for discount.

Returns:

value

setDiscount

public void setDiscount(Discount discount)

Set the 'Discount' element value. Discount percentage and/or Amount, code and textual reason for discount.

Parameters:

discount -

getTotal

public Total getTotal()

Get the 'Total' element value. The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.

Returns:

value

setTotal

public void setTotal(Total total)

Set the 'Total' element value. The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.

Parameters:

total -

getBasicPropertyInfo

public BasicPropertyInfo getBasicPropertyInfo()

Get the 'BasicPropertyInfo' element value. Property Information for the Room Stay.

Returns:

value

setBasicPropertyInfo

public void setBasicPropertyInfo(BasicPropertyInfo basicPropertyInfo)

Set the 'BasicPropertyInfo' element value. Property Information for the Room Stay.

Parameters:

basicPropertyInfo -

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 -

getMarketCode

public java.lang.String getMarketCode()

Get the 'MarketCode' attribute value. The code that relates to the market being sold to (e.g., the corporate market, packages).

Returns:

value

setMarketCode

public void setMarketCode(java.lang.String marketCode)

Set the 'MarketCode' attribute value. The code that relates to the market being sold to (e.g., the corporate market, packages).

Parameters:

marketCode -

getSourceOfBusiness

public java.lang.String getSourceOfBusiness()

Get the 'SourceOfBusiness' attribute value. To specify where the business came from e.g. radio, newspaper ad, etc.

Returns:

value

setSourceOfBusiness

public void setSourceOfBusiness(java.lang.String sourceOfBusiness)

Set the 'SourceOfBusiness' attribute value. To specify where the business came from e.g. radio, newspaper ad, etc.

Parameters:

sourceOfBusiness -

getDiscountCode

public java.lang.String getDiscountCode()

Get the 'DiscountCode' attribute value.

Returns:

value

setDiscountCode

public void setDiscountCode(java.lang.String discountCode)

Set the 'DiscountCode' attribute value.

Parameters:

discountCode -

getPromotionCodeGroup

public PromotionCodeGroup getPromotionCodeGroup()

Get the 'PromotionCodeGroup' attributeGroup value.

Returns:

value

setPromotionCodeGroup

public void setPromotionCodeGroup(PromotionCodeGroup promotionCodeGroup)

Set the 'PromotionCodeGroup' attributeGroup value.

Parameters:

promotionCodeGroup -

getRoomStayStatus

public java.lang.String getRoomStayStatus()

Get the 'RoomStayStatus' attribute value. Identifies the status of the room stay.

Returns:

value

setRoomStayStatus

public void setRoomStayStatus(java.lang.String roomStayStatus)

Set the 'RoomStayStatus' attribute value. Identifies the status of the room stay.

Parameters:

roomStayStatus -

getWarningRPH

public java.lang.String getWarningRPH()

Get the 'WarningRPH' attribute value. This references the RPH found in the Warning element. Used to identify the warnings associated with this RoomStay.

Returns:

value

setWarningRPH

public void setWarningRPH(java.lang.String warningRPH)

Set the 'WarningRPH' attribute value. This references the RPH found in the Warning element. Used to identify the warnings associated with this RoomStay.

Parameters:

warningRPH -