org.ota.shared
Class Fee

java.lang.Object
  extended by org.ota.shared.Fee
Direct Known Subclasses:
HotelDescriptiveContent.Policies.Policy.CommissionPolicy, HotelRatePlan.RatePlanLevelFee.Fee

public class Fee
extends java.lang.Object

Used for non-tax fees and charges (e.g. service charges) . 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="FeeType">
   <xs:sequence>
     <xs:element type="ns:TaxesType" name="Taxes" minOccurs="0"/>
     <xs:element type="ns:ParagraphType" name="Description" minOccurs="0" maxOccurs="5"/>
   </xs:sequence>
   <xs:attribute type="xs:boolean" name="TaxInclusive"/>
   <xs:attributeGroup ref="ns:FeeTaxGroup"/>
   <xs:attributeGroup ref="ns:EffectiveExpireOptionalDateGroup"/>
   <xs:attribute type="xs:boolean" use="optional" name="MandatoryIndicator"/>
   <xs:attribute type="xs:string" use="optional" name="RPH"/>
   <xs:attributeGroup ref="ns:ChargeUnitGroup"/>
   <xs:attribute type="xs:boolean" use="optional" name="TaxableIndicator"/>
 </xs:complexType>
 


Constructor Summary
Fee()
           
 
Method Summary
 void addDescription(Paragraph item)
          Add a 'Description' element item.
 void clearDescriptions()
          Remove all 'Description' element items.
 ChargeUnitGroup getChargeUnitGroup()
          Get the 'ChargeUnitGroup' attributeGroup value.
 Paragraph getDescription(int index)
          Get 'Description' element item by position.
 java.util.List<Paragraph> getDescriptions()
          Get the list of 'Description' element items.
 EffectiveExpireOptionalDateGroup getEffectiveExpireOptionalDateGroup()
          Get the 'EffectiveExpireOptionalDateGroup' attributeGroup value.
 FeeTaxGroup getFeeTaxGroup()
          Get the 'FeeTaxGroup' attributeGroup value.
 java.lang.Boolean getMandatoryIndicator()
          Get the 'MandatoryIndicator' attribute value.
 java.lang.String getRPH()
          Get the 'RPH' attribute value.
 java.lang.Boolean getTaxableIndicator()
          Get the 'TaxableIndicator' attribute value.
 Taxes getTaxes()
          Get the 'Taxes' element value.
 java.lang.Boolean getTaxInclusive()
          Get the 'TaxInclusive' attribute value.
 void setChargeUnitGroup(ChargeUnitGroup chargeUnitGroup)
          Set the 'ChargeUnitGroup' attributeGroup value.
 void setDescriptions(java.util.List<Paragraph> list)
          Set the list of 'Description' element items.
 void setEffectiveExpireOptionalDateGroup(EffectiveExpireOptionalDateGroup effectiveExpireOptionalDateGroup)
          Set the 'EffectiveExpireOptionalDateGroup' attributeGroup value.
 void setFeeTaxGroup(FeeTaxGroup feeTaxGroup)
          Set the 'FeeTaxGroup' attributeGroup value.
 void setMandatoryIndicator(java.lang.Boolean mandatoryIndicator)
          Set the 'MandatoryIndicator' attribute value.
 void setRPH(java.lang.String RPH)
          Set the 'RPH' attribute value.
 void setTaxableIndicator(java.lang.Boolean taxableIndicator)
          Set the 'TaxableIndicator' attribute value.
 void setTaxes(Taxes taxes)
          Set the 'Taxes' element value.
 void setTaxInclusive(java.lang.Boolean taxInclusive)
          Set the 'TaxInclusive' attribute value.
 int sizeDescriptions()
          Get the number of 'Description' element items.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Fee

public Fee()
Method Detail

getTaxes

public Taxes getTaxes()
Get the 'Taxes' element value. Used for taxes on the associated fee.

Returns:
value

setTaxes

public void setTaxes(Taxes taxes)
Set the 'Taxes' element value. Used for taxes on the associated fee.

Parameters:
taxes -

getDescriptions

public java.util.List<Paragraph> getDescriptions()
Get the list of 'Description' element items. Text description of the fees in a given language.

Returns:
list

setDescriptions

public void setDescriptions(java.util.List<Paragraph> list)
Set the list of 'Description' element items. Text description of the fees in a given language.

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.


getTaxInclusive

public java.lang.Boolean getTaxInclusive()
Get the 'TaxInclusive' attribute value. Indicates whether taxes are included when figuring the fees.

Returns:
value

setTaxInclusive

public void setTaxInclusive(java.lang.Boolean taxInclusive)
Set the 'TaxInclusive' attribute value. Indicates whether taxes are included when figuring the fees.

Parameters:
taxInclusive -

getFeeTaxGroup

public FeeTaxGroup getFeeTaxGroup()
Get the 'FeeTaxGroup' attributeGroup value. Provides details of the fee.

Returns:
value

setFeeTaxGroup

public void setFeeTaxGroup(FeeTaxGroup feeTaxGroup)
Set the 'FeeTaxGroup' attributeGroup value. Provides details of the fee.

Parameters:
feeTaxGroup -

getEffectiveExpireOptionalDateGroup

public EffectiveExpireOptionalDateGroup getEffectiveExpireOptionalDateGroup()
Get the 'EffectiveExpireOptionalDateGroup' attributeGroup value. Provides the effective and expiry dates for the fee.

Returns:
value

setEffectiveExpireOptionalDateGroup

public void setEffectiveExpireOptionalDateGroup(EffectiveExpireOptionalDateGroup effectiveExpireOptionalDateGroup)
Set the 'EffectiveExpireOptionalDateGroup' attributeGroup value. Provides the effective and expiry dates for the fee.

Parameters:
effectiveExpireOptionalDateGroup -

getMandatoryIndicator

public java.lang.Boolean getMandatoryIndicator()
Get the 'MandatoryIndicator' attribute value. When true, indicates the fee is mandatory. When false, the fee is not mandatory.

Returns:
value

setMandatoryIndicator

public void setMandatoryIndicator(java.lang.Boolean mandatoryIndicator)
Set the 'MandatoryIndicator' attribute value. When true, indicates the fee is mandatory. When false, the fee is not mandatory.

Parameters:
mandatoryIndicator -

getRPH

public java.lang.String getRPH()
Get the 'RPH' attribute value. An index code to identify an instance in a collection of like items.

Returns:
value

setRPH

public void setRPH(java.lang.String RPH)
Set the 'RPH' attribute value. An index code to identify an instance in a collection of like items.

Parameters:
RPH -

getChargeUnitGroup

public ChargeUnitGroup getChargeUnitGroup()
Get the 'ChargeUnitGroup' attributeGroup value. Specifies charge information by unit (e.g., room, person, item) and frequency (e.g., daily, weekly, stay).

Returns:
value

setChargeUnitGroup

public void setChargeUnitGroup(ChargeUnitGroup chargeUnitGroup)
Set the 'ChargeUnitGroup' attributeGroup value. Specifies charge information by unit (e.g., room, person, item) and frequency (e.g., daily, weekly, stay).

Parameters:
chargeUnitGroup -

getTaxableIndicator

public java.lang.Boolean getTaxableIndicator()
Get the 'TaxableIndicator' attribute value. When true, indicates that the fee is subject to tax.

Returns:
value

setTaxableIndicator

public void setTaxableIndicator(java.lang.Boolean taxableIndicator)
Set the 'TaxableIndicator' attribute value. When true, indicates that the fee is subject to tax.

Parameters:
taxableIndicator -