org.ota.hotel
Class HotelRatePlan.Supplements.Supplement

java.lang.Object
  org.ota.hotel.HotelRatePlan.Supplements.Supplement

Enclosing class:

HotelRatePlan.Supplements

public static class HotelRatePlan.Supplements.Supplement
extends java.lang.Object

Single supplement with conditions of application. 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="Supplement" maxOccurs="unbounded">
   <xs:complexType>
     <xs:sequence>
       <xs:element name="RoomCompanions" minOccurs="0" maxOccurs="5">
         <!-- Reference to inner class RoomCompanions -->
       </xs:element>
       <xs:element name="PrerequisiteInventory" minOccurs="0" maxOccurs="5">
         <!-- Reference to inner class PrerequisiteInventory -->
       </xs:element>
       <xs:element type="ns:ParagraphType" name="Description" minOccurs="0" maxOccurs="5"/>
     </xs:sequence>
     <xs:attributeGroup ref="ns:AgeQualifyingGroup"/>
     <xs:attributeGroup ref="ns:CurrencyAmountGroup"/>
     <xs:attributeGroup ref="ns:DateTimeSpanGroup"/>
     <xs:attribute use="optional" name="SupplementType">
       <xs:simpleType>
         <!-- Reference to inner class SupplementInner -->
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute type="xs:string" use="optional" name="ChargeTypeCode"/>
     <xs:attribute type="xs:string" use="optional" name="InvCode"/>
     <xs:attribute type="xs:string" use="optional" name="InvType"/>
     <xs:attribute type="xs:int" use="optional" name="AdditionalGuestNumber"/>
     <xs:attribute type="xs:string" use="optional" name="RPH"/>
     <xs:attribute type="xs:float" use="optional" name="Percent"/>
     <xs:attribute type="xs:boolean" use="optional" name="AddToBasicRateIndicator"/>
     <xs:attribute type="xs:boolean" use="optional" name="SingleUseIndicator"/>
     <xs:attribute type="xs:boolean" use="optional" name="MandatoryIndicator"/>
   </xs:complexType>
 </xs:element>
 

Nested Class Summary

static class	HotelRatePlan.Supplements.Supplement.PrerequisiteInventory Defines inventory (e.g.
static class	HotelRatePlan.Supplements.Supplement.RoomCompanions Defines the required type and number of companions in the room in order for this supplement to apply (e.g., one adult required for a child supplement to apply).
static class	HotelRatePlan.Supplements.Supplement.SupplementInner Schema fragment(s) for this class:

Constructor Summary

HotelRatePlan.Supplements.Supplement()

Method Summary

void	addDescription(Paragraph item) Add a 'Description' element item.
void	addPrerequisiteInventory(HotelRatePlan.Supplements.Supplement.PrerequisiteInventory item) Add a 'PrerequisiteInventory' element item.
void	addRoomCompanion(HotelRatePlan.Supplements.Supplement.RoomCompanions item) Add a 'RoomCompanions' element item.
void	clearDescriptions() Remove all 'Description' element items.
void	clearPrerequisiteInventories() Remove all 'PrerequisiteInventory' element items.
void	clearRoomCompanions() Remove all 'RoomCompanions' element items.
java.lang.Integer	getAdditionalGuestNumber() Get the 'AdditionalGuestNumber' attribute value.
java.lang.Boolean	getAddToBasicRateIndicator() Get the 'AddToBasicRateIndicator' attribute value.
AgeQualifyingGroup	getAgeQualifyingGroup() Get the 'AgeQualifyingGroup' attributeGroup value.
java.lang.String	getChargeTypeCode() Get the 'ChargeTypeCode' attribute value.
CurrencyAmountGroup	getCurrencyAmountGroup() Get the 'CurrencyAmountGroup' attributeGroup value.
DateTimeSpanGroup	getDateTimeSpanGroup() Get the 'DateTimeSpanGroup' attributeGroup value.
Paragraph	getDescription(int index) Get 'Description' element item by position.
java.util.List<Paragraph>	getDescriptions() Get the list of 'Description' element items.
java.lang.String	getInv() Get the 'InvType' attribute value.
java.lang.String	getInvCode() Get the 'InvCode' attribute value.
java.lang.Boolean	getMandatoryIndicator() Get the 'MandatoryIndicator' attribute value.
java.lang.Float	getPercent() Get the 'Percent' attribute value.
java.util.List<HotelRatePlan.Supplements.Supplement.PrerequisiteInventory>	getPrerequisiteInventories() Get the list of 'PrerequisiteInventory' element items.
HotelRatePlan.Supplements.Supplement.PrerequisiteInventory	getPrerequisiteInventory(int index) Get 'PrerequisiteInventory' element item by position.
HotelRatePlan.Supplements.Supplement.RoomCompanions	getRoomCompanion(int index) Get 'RoomCompanions' element item by position.
java.util.List<HotelRatePlan.Supplements.Supplement.RoomCompanions>	getRoomCompanions() Get the list of 'RoomCompanions' element items.
java.lang.String	getRPH() Get the 'RPH' attribute value.
java.lang.Boolean	getSingleUseIndicator() Get the 'SingleUseIndicator' attribute value.
HotelRatePlan.Supplements.Supplement.SupplementInner	getSupplement() Get the 'SupplementType' attribute value.
void	setAdditionalGuestNumber(java.lang.Integer additionalGuestNumber) Set the 'AdditionalGuestNumber' attribute value.
void	setAddToBasicRateIndicator(java.lang.Boolean addToBasicRateIndicator) Set the 'AddToBasicRateIndicator' attribute value.
void	setAgeQualifyingGroup(AgeQualifyingGroup ageQualifyingGroup) Set the 'AgeQualifyingGroup' attributeGroup value.
void	setChargeTypeCode(java.lang.String chargeTypeCode) Set the 'ChargeTypeCode' attribute value.
void	setCurrencyAmountGroup(CurrencyAmountGroup currencyAmountGroup) Set the 'CurrencyAmountGroup' attributeGroup value.
void	setDateTimeSpanGroup(DateTimeSpanGroup dateTimeSpanGroup) Set the 'DateTimeSpanGroup' attributeGroup value.
void	setDescriptions(java.util.List<Paragraph> list) Set the list of 'Description' element items.
void	setInv(java.lang.String inv) Set the 'InvType' attribute value.
void	setInvCode(java.lang.String invCode) Set the 'InvCode' attribute value.
void	setMandatoryIndicator(java.lang.Boolean mandatoryIndicator) Set the 'MandatoryIndicator' attribute value.
void	setPercent(java.lang.Float percent) Set the 'Percent' attribute value.
void	setPrerequisiteInventories(java.util.List<HotelRatePlan.Supplements.Supplement.PrerequisiteInventory> list) Set the list of 'PrerequisiteInventory' element items.
void	setRoomCompanions(java.util.List<HotelRatePlan.Supplements.Supplement.RoomCompanions> list) Set the list of 'RoomCompanions' element items.
void	setRPH(java.lang.String RPH) Set the 'RPH' attribute value.
void	setSingleUseIndicator(java.lang.Boolean singleUseIndicator) Set the 'SingleUseIndicator' attribute value.
void	setSupplement(HotelRatePlan.Supplements.Supplement.SupplementInner supplement) Set the 'SupplementType' attribute value.
int	sizeDescriptions() Get the number of 'Description' element items.
int	sizePrerequisiteInventories() Get the number of 'PrerequisiteInventory' element items.
int	sizeRoomCompanions() Get the number of 'RoomCompanions' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

HotelRatePlan.Supplements.Supplement

public HotelRatePlan.Supplements.Supplement()

Method Detail

getRoomCompanions

public java.util.List<HotelRatePlan.Supplements.Supplement.RoomCompanions> getRoomCompanions()

Get the list of 'RoomCompanions' element items.

Returns:

list

setRoomCompanions

public void setRoomCompanions(java.util.List<HotelRatePlan.Supplements.Supplement.RoomCompanions> list)

Set the list of 'RoomCompanions' element items.

Parameters:

list -

sizeRoomCompanions

public int sizeRoomCompanions()

Get the number of 'RoomCompanions' element items.

Returns:

count

addRoomCompanion

public void addRoomCompanion(HotelRatePlan.Supplements.Supplement.RoomCompanions item)

Add a 'RoomCompanions' element item.

Parameters:

item -

getRoomCompanion

public HotelRatePlan.Supplements.Supplement.RoomCompanions getRoomCompanion(int index)

Get 'RoomCompanions' element item by position.

Parameters:

index -

Returns:

item

clearRoomCompanions

public void clearRoomCompanions()

Remove all 'RoomCompanions' element items.

getPrerequisiteInventories

public java.util.List<HotelRatePlan.Supplements.Supplement.PrerequisiteInventory> getPrerequisiteInventories()

Get the list of 'PrerequisiteInventory' element items.

Returns:

list

setPrerequisiteInventories

public void setPrerequisiteInventories(java.util.List<HotelRatePlan.Supplements.Supplement.PrerequisiteInventory> list)

Set the list of 'PrerequisiteInventory' element items.

Parameters:

list -

sizePrerequisiteInventories

public int sizePrerequisiteInventories()

Get the number of 'PrerequisiteInventory' element items.

Returns:

count

addPrerequisiteInventory

public void addPrerequisiteInventory(HotelRatePlan.Supplements.Supplement.PrerequisiteInventory item)

Add a 'PrerequisiteInventory' element item.

Parameters:

item -

getPrerequisiteInventory

public HotelRatePlan.Supplements.Supplement.PrerequisiteInventory getPrerequisiteInventory(int index)

Get 'PrerequisiteInventory' element item by position.

Parameters:

index -

Returns:

item

clearPrerequisiteInventories

public void clearPrerequisiteInventories()

Remove all 'PrerequisiteInventory' element items.

getDescriptions

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

Get the list of 'Description' element items. Description of the supplement.

Returns:

list

setDescriptions

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

Set the list of 'Description' element items. Description of the supplement.

Parameters:

list -

sizeDescriptions

public int sizeDescriptions()

Get the number of 'Description' element items.

Returns:

count

addDescription

public void addDescription(Paragraph item)

Add a 'Description' element item.

Parameters:

item -

getDescription

public Paragraph getDescription(int index)

Get 'Description' element item by position.

Parameters:

index -

Returns:

item

clearDescriptions

public void clearDescriptions()

Remove all 'Description' element items.

getAgeQualifyingGroup

public AgeQualifyingGroup getAgeQualifyingGroup()

Get the 'AgeQualifyingGroup' attributeGroup value. Defines the required ages of the guests in order for this supplement to apply.

Returns:

value

setAgeQualifyingGroup

public void setAgeQualifyingGroup(AgeQualifyingGroup ageQualifyingGroup)

Set the 'AgeQualifyingGroup' attributeGroup value. Defines the required ages of the guests in order for this supplement to apply.

Parameters:

ageQualifyingGroup -

getCurrencyAmountGroup

public CurrencyAmountGroup getCurrencyAmountGroup()

Get the 'CurrencyAmountGroup' attributeGroup value. Provides the supplement amount (positive or negative) to be applied.

Returns:

value

setCurrencyAmountGroup

public void setCurrencyAmountGroup(CurrencyAmountGroup currencyAmountGroup)

Set the 'CurrencyAmountGroup' attributeGroup value. Provides the supplement amount (positive or negative) to be applied.

Parameters:

currencyAmountGroup -

getDateTimeSpanGroup

public DateTimeSpanGroup getDateTimeSpanGroup()

Get the 'DateTimeSpanGroup' attributeGroup value. The valid dates for the supplement.

Returns:

value

setDateTimeSpanGroup

public void setDateTimeSpanGroup(DateTimeSpanGroup dateTimeSpanGroup)

Set the 'DateTimeSpanGroup' attributeGroup value. The valid dates for the supplement.

Parameters:

dateTimeSpanGroup -

getSupplement

public HotelRatePlan.Supplements.Supplement.SupplementInner getSupplement()

Get the 'SupplementType' attribute value. An enumerated type that indicates the nature of the supplement.

Returns:

value

setSupplement

public void setSupplement(HotelRatePlan.Supplements.Supplement.SupplementInner supplement)

Set the 'SupplementType' attribute value. An enumerated type that indicates the nature of the supplement.

Parameters:

supplement -

getChargeTypeCode

public java.lang.String getChargeTypeCode()

Get the 'ChargeTypeCode' attribute value. Describes what the charge refers to and with what frequency. Refer to OpenTravel Code Table Charge Type (CHG).

Returns:

value

setChargeTypeCode

public void setChargeTypeCode(java.lang.String chargeTypeCode)

Set the 'ChargeTypeCode' attribute value. Describes what the charge refers to and with what frequency. Refer to OpenTravel Code Table Charge Type (CHG).

Parameters:

chargeTypeCode -

getInvCode

public java.lang.String getInvCode()

Get the 'InvCode' attribute value. A code defining the inventory item to which this supplement applies.

Returns:

value

setInvCode

public void setInvCode(java.lang.String invCode)

Set the 'InvCode' attribute value. A code defining the inventory item to which this supplement applies.

Parameters:

invCode -

getInv

public java.lang.String getInv()

Get the 'InvType' attribute value. The inventory type to which the supplement applies.

Returns:

value

setInv

public void setInv(java.lang.String inv)

Set the 'InvType' attribute value. The inventory type to which the supplement applies.

Parameters:

inv -

getAdditionalGuestNumber

public java.lang.Integer getAdditionalGuestNumber()

Get the 'AdditionalGuestNumber' attribute value. The number of the guest of this age group beyond the standard occupancy for the room (e.g., Double room with standard occupancy =2; AdditionalGuestNumber = 1 => 3rd adult AdditionalGuestNumber = 2 => 4th adult ).

Returns:

value

setAdditionalGuestNumber

public void setAdditionalGuestNumber(java.lang.Integer additionalGuestNumber)

Set the 'AdditionalGuestNumber' attribute value. The number of the guest of this age group beyond the standard occupancy for the room (e.g., Double room with standard occupancy =2; AdditionalGuestNumber = 1 => 3rd adult AdditionalGuestNumber = 2 => 4th adult ).

Parameters:

additionalGuestNumber -

getRPH

public java.lang.String getRPH()

Get the 'RPH' attribute value. This reference placeholder is commonly used to associate this supplement with the appropriate offer(s).

Returns:

value

setRPH

public void setRPH(java.lang.String RPH)

Set the 'RPH' attribute value. This reference placeholder is commonly used to associate this supplement with the appropriate offer(s).

Parameters:

RPH -

getPercent

public java.lang.Float getPercent()

Get the 'Percent' attribute value. The percentage (postiive or negative) to be applied to the basic rate to calculate the supplement amount.

Returns:

value

setPercent

public void setPercent(java.lang.Float percent)

Set the 'Percent' attribute value. The percentage (postiive or negative) to be applied to the basic rate to calculate the supplement amount.

Parameters:

percent -

getAddToBasicRateIndicator

public java.lang.Boolean getAddToBasicRateIndicator()

Get the 'AddToBasicRateIndicator' attribute value. When true, indicates that the value in Amount must be added to the basic rate, otherwise it would replace the basic rate amount.

Returns:

value

setAddToBasicRateIndicator

public void setAddToBasicRateIndicator(java.lang.Boolean addToBasicRateIndicator)

Set the 'AddToBasicRateIndicator' attribute value. When true, indicates that the value in Amount must be added to the basic rate, otherwise it would replace the basic rate amount.

Parameters:

addToBasicRateIndicator -

getSingleUseIndicator

public java.lang.Boolean getSingleUseIndicator()

Get the 'SingleUseIndicator' attribute value. When true, indicates that this is a supplement for single use (e.g., indicates that this supplement is the additional amount charged for single use of a double room).

Returns:

value

setSingleUseIndicator

public void setSingleUseIndicator(java.lang.Boolean singleUseIndicator)

Set the 'SingleUseIndicator' attribute value. When true, indicates that this is a supplement for single use (e.g., indicates that this supplement is the additional amount charged for single use of a double room).

Parameters:

singleUseIndicator -

getMandatoryIndicator

public java.lang.Boolean getMandatoryIndicator()

Get the 'MandatoryIndicator' attribute value. When true, indicates that this supplement must be applied when applicable (e.g., a surcharge for "Xmas Eve Gala Dinner" which must be applied if the room is booked for December 24th).

Returns:

value

setMandatoryIndicator

public void setMandatoryIndicator(java.lang.Boolean mandatoryIndicator)

Set the 'MandatoryIndicator' attribute value. When true, indicates that this supplement must be applied when applicable (e.g., a surcharge for "Xmas Eve Gala Dinner" which must be applied if the room is booked for December 24th).

Parameters:

mandatoryIndicator -