org.ota.hotel
Class RoomStayCandidate

java.lang.Object
  org.ota.hotel.RoomStayCandidate

Direct Known Subclasses:

AvailRequestSegments.AvailRequestSegment.RoomStayCandidates.RoomStayCandidate, RoomProfile

public class RoomStayCandidate
extends java.lang.Object

Used to identify available room products. 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="RoomStayCandidateType">
   <xs:sequence>
     <xs:element type="ns:GuestCountType" name="GuestCounts" minOccurs="0"/>
     <xs:element type="ns:RoomAmenityPrefType" name="RoomAmenity" minOccurs="0" maxOccurs="5"/>
   </xs:sequence>
   <xs:attributeGroup ref="ns:RoomGroup"/>
   <xs:attribute type="xs:string" use="optional" name="RPH"/>
   <xs:attribute type="xs:string" use="optional" name="RatePlanCandidateRPH"/>
   <xs:attribute type="xs:string" use="optional" name="BookingCode"/>
   <xs:attributeGroup ref="ns:EffectiveExpireOptionalDateGroup"/>
 </xs:complexType>
 

Constructor Summary

RoomStayCandidate()

Method Summary

void	addRoomAmenity(RoomAmenityPref item) Add a 'RoomAmenity' element item.
void	clearRoomAmenities() Remove all 'RoomAmenity' element items.
java.lang.String	getBookingCode() Get the 'BookingCode' attribute value.
EffectiveExpireOptionalDateGroup	getEffectiveExpireOptionalDateGroup() Get the 'EffectiveExpireOptionalDateGroup' attributeGroup value.
GuestCount	getGuestCounts() Get the 'GuestCounts' element value.
java.lang.String	getRatePlanCandidateRPH() Get the 'RatePlanCandidateRPH' attribute value.
java.util.List<RoomAmenityPref>	getRoomAmenities() Get the list of 'RoomAmenity' element items.
RoomAmenityPref	getRoomAmenity(int index) Get 'RoomAmenity' element item by position.
RoomGroup	getRoomGroup() Get the 'RoomGroup' attributeGroup value.
java.lang.String	getRPH() Get the 'RPH' attribute value.
void	setBookingCode(java.lang.String bookingCode) Set the 'BookingCode' attribute value.
void	setEffectiveExpireOptionalDateGroup(EffectiveExpireOptionalDateGroup effectiveExpireOptionalDateGroup) Set the 'EffectiveExpireOptionalDateGroup' attributeGroup value.
void	setGuestCounts(GuestCount guestCounts) Set the 'GuestCounts' element value.
void	setRatePlanCandidateRPH(java.lang.String ratePlanCandidateRPH) Set the 'RatePlanCandidateRPH' attribute value.
void	setRoomAmenities(java.util.List<RoomAmenityPref> list) Set the list of 'RoomAmenity' element items.
void	setRoomGroup(RoomGroup roomGroup) Set the 'RoomGroup' attributeGroup value.
void	setRPH(java.lang.String RPH) Set the 'RPH' attribute value.
int	sizeRoomAmenities() Get the number of 'RoomAmenity' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomStayCandidate

public RoomStayCandidate()

Method Detail

getGuestCounts

public GuestCount getGuestCounts()

Get the 'GuestCounts' element value.

Returns:

value

setGuestCounts

public void setGuestCounts(GuestCount guestCounts)

Set the 'GuestCounts' element value.

Parameters:

guestCounts -

getRoomAmenities

public java.util.List<RoomAmenityPref> getRoomAmenities()

Get the list of 'RoomAmenity' element items. This element is used to pass room attributes. Typical attributes are smoking, non-smoking, wheelchair access, room location (low floor, high floor, close to elevator, etc) and view (garden, pool, ocean, etc)

Returns:

list

setRoomAmenities

public void setRoomAmenities(java.util.List<RoomAmenityPref> list)

Set the list of 'RoomAmenity' element items. This element is used to pass room attributes. Typical attributes are smoking, non-smoking, wheelchair access, room location (low floor, high floor, close to elevator, etc) and view (garden, pool, ocean, etc)

Parameters:

list -

sizeRoomAmenities

public int sizeRoomAmenities()

Get the number of 'RoomAmenity' element items.

Returns:

count

addRoomAmenity

public void addRoomAmenity(RoomAmenityPref item)

Add a 'RoomAmenity' element item.

Parameters:

item -

getRoomAmenity

public RoomAmenityPref getRoomAmenity(int index)

Get 'RoomAmenity' element item by position.

Parameters:

index -

Returns:

item

clearRoomAmenities

public void clearRoomAmenities()

Remove all 'RoomAmenity' element items.

getRoomGroup

public RoomGroup getRoomGroup()

Get the 'RoomGroup' attributeGroup value.

Returns:

value

setRoomGroup

public void setRoomGroup(RoomGroup roomGroup)

Set the 'RoomGroup' attributeGroup value.

Parameters:

roomGroup -

getRPH

public java.lang.String getRPH()

Get the 'RPH' attribute value. A unique identifier for this room stay candidate.

Returns:

value

setRPH

public void setRPH(java.lang.String RPH)

Set the 'RPH' attribute value. A unique identifier for this room stay candidate.

Parameters:

RPH -

getRatePlanCandidateRPH

public java.lang.String getRatePlanCandidateRPH()

Get the 'RatePlanCandidateRPH' attribute value. Used to refer to the Rate Plan Candidate associated with this room stay.

Returns:

value

setRatePlanCandidateRPH

public void setRatePlanCandidateRPH(java.lang.String ratePlanCandidateRPH)

Set the 'RatePlanCandidateRPH' attribute value. Used to refer to the Rate Plan Candidate associated with this room stay.

Parameters:

ratePlanCandidateRPH -

getBookingCode

public java.lang.String getBookingCode()

Get the 'BookingCode' attribute value. Used to specify the booking code for which availability is requested.

Returns:

value

setBookingCode

public void setBookingCode(java.lang.String bookingCode)

Set the 'BookingCode' attribute value. Used to specify the booking code for which availability is requested.

Parameters:

bookingCode -

getEffectiveExpireOptionalDateGroup

public EffectiveExpireOptionalDateGroup getEffectiveExpireOptionalDateGroup()

Get the 'EffectiveExpireOptionalDateGroup' attributeGroup value. Identifies the dates when the RoomStayCandidate is applicable when there are multiple room stay requirements within a StayDateRange.

Returns:

value

setEffectiveExpireOptionalDateGroup

public void setEffectiveExpireOptionalDateGroup(EffectiveExpireOptionalDateGroup effectiveExpireOptionalDateGroup)

Set the 'EffectiveExpireOptionalDateGroup' attributeGroup value. Identifies the dates when the RoomStayCandidate is applicable when there are multiple room stay requirements within a StayDateRange.

Parameters:

effectiveExpireOptionalDateGroup -