org.ota.shared
Class Commission

java.lang.Object
  org.ota.shared.Commission

public class Commission
extends java.lang.Object

Contains details pertaining to commissions. 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="CommissionType">
   <xs:sequence>
     <xs:element type="ns:UniqueID_Type" name="UniqueID" minOccurs="0"/>
     <xs:element name="CommissionableAmount" minOccurs="0">
       <!-- Reference to inner class CommissionableAmount -->
     </xs:element>
     <xs:element name="PrepaidAmount" minOccurs="0">
       <xs:complexType>
         <xs:attributeGroup ref="ns:CurrencyAmountGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element name="FlatCommission" minOccurs="0">
       <xs:complexType>
         <xs:attributeGroup ref="ns:CurrencyAmountGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element name="CommissionPayableAmount" minOccurs="0">
       <xs:complexType>
         <xs:attributeGroup ref="ns:CurrencyAmountGroup"/>
       </xs:complexType>
     </xs:element>
     <xs:element type="ns:ParagraphType" name="Comment" minOccurs="0"/>
   </xs:sequence>
   <xs:attribute use="optional" name="StatusType">
     <xs:simpleType>
       <!-- Reference to inner class Status -->
     </xs:simpleType>
   </xs:attribute>
   <xs:attribute type="xs:float" use="optional" name="Percent"/>
   <xs:attributeGroup ref="ns:CurrencyCodeGroup"/>
   <xs:attribute type="xs:string" use="optional" name="ReasonCode"/>
   <xs:attribute type="xs:string" use="optional" name="BillToID"/>
   <xs:attribute type="xs:string" use="optional" name="Frequency"/>
   <xs:attribute type="xs:string" use="optional" name="MaxCommissionUnitApplies"/>
   <xs:attribute type="xs:float" use="optional" name="CapAmount"/>
 </xs:complexType>
 

Nested Class Summary

static class	Commission.CommissionableAmount The amount on which commission is calculated.
static class	Commission.Status Schema fragment(s) for this class:

Constructor Summary

Commission()

Method Summary

java.lang.String	getBillToID() Get the 'BillToID' attribute value.
java.lang.Float	getCapAmount() Get the 'CapAmount' attribute value.
Paragraph	getComment() Get the 'Comment' element value.
Commission.CommissionableAmount	getCommissionableAmount() Get the 'CommissionableAmount' element value.
CurrencyAmountGroup	getCommissionPayableAmount() Get the 'CurrencyAmountGroup' attributeGroup value.
CurrencyCodeGroup	getCurrencyCodeGroup() Get the 'CurrencyCodeGroup' attributeGroup value.
CurrencyAmountGroup	getFlatCommission() Get the 'CurrencyAmountGroup' attributeGroup value.
java.lang.String	getFrequency() Get the 'Frequency' attribute value.
java.lang.String	getMaxCommissionUnitApplies() Get the 'MaxCommissionUnitApplies' attribute value.
java.lang.Float	getPercent() Get the 'Percent' attribute value.
CurrencyAmountGroup	getPrepaidAmount() Get the 'CurrencyAmountGroup' attributeGroup value.
java.lang.String	getReasonCode() Get the 'ReasonCode' attribute value.
Commission.Status	getStatus() Get the 'StatusType' attribute value.
UniqueID	getUniqueID() Get the 'UniqueID' element value.
void	setBillToID(java.lang.String billToID) Set the 'BillToID' attribute value.
void	setCapAmount(java.lang.Float capAmount) Set the 'CapAmount' attribute value.
void	setComment(Paragraph comment) Set the 'Comment' element value.
void	setCommissionableAmount(Commission.CommissionableAmount commissionableAmount) Set the 'CommissionableAmount' element value.
void	setCommissionPayableAmount(CurrencyAmountGroup commissionPayableAmount) Set the 'CurrencyAmountGroup' attributeGroup value.
void	setCurrencyCodeGroup(CurrencyCodeGroup currencyCodeGroup) Set the 'CurrencyCodeGroup' attributeGroup value.
void	setFlatCommission(CurrencyAmountGroup flatCommission) Set the 'CurrencyAmountGroup' attributeGroup value.
void	setFrequency(java.lang.String frequency) Set the 'Frequency' attribute value.
void	setMaxCommissionUnitApplies(java.lang.String maxCommissionUnitApplies) Set the 'MaxCommissionUnitApplies' attribute value.
void	setPercent(java.lang.Float percent) Set the 'Percent' attribute value.
void	setPrepaidAmount(CurrencyAmountGroup prepaidAmount) Set the 'CurrencyAmountGroup' attributeGroup value.
void	setReasonCode(java.lang.String reasonCode) Set the 'ReasonCode' attribute value.
void	setStatus(Commission.Status status) Set the 'StatusType' attribute value.
void	setUniqueID(UniqueID uniqueID) Set the 'UniqueID' element value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Commission

public Commission()

Method Detail

getUniqueID

public UniqueID getUniqueID()

Get the 'UniqueID' element value. Identifies the recipient of the commission.

Returns:

value

setUniqueID

public void setUniqueID(UniqueID uniqueID)

Set the 'UniqueID' element value. Identifies the recipient of the commission.

Parameters:

uniqueID -

getCommissionableAmount

public Commission.CommissionableAmount getCommissionableAmount()

Get the 'CommissionableAmount' element value.

Returns:

value

setCommissionableAmount

public void setCommissionableAmount(Commission.CommissionableAmount commissionableAmount)

Set the 'CommissionableAmount' element value.

Parameters:

commissionableAmount -

getPrepaidAmount

public CurrencyAmountGroup getPrepaidAmount()

Get the 'CurrencyAmountGroup' attributeGroup value. Provides the amount of commission paid to the agency prior to the service being rendered.

Returns:

value

setPrepaidAmount

public void setPrepaidAmount(CurrencyAmountGroup prepaidAmount)

Set the 'CurrencyAmountGroup' attributeGroup value. Provides the amount of commission paid to the agency prior to the service being rendered.

Parameters:

prepaidAmount -

getFlatCommission

public CurrencyAmountGroup getFlatCommission()

Get the 'CurrencyAmountGroup' attributeGroup value. A fixed commission amount.

Returns:

value

setFlatCommission

public void setFlatCommission(CurrencyAmountGroup flatCommission)

Set the 'CurrencyAmountGroup' attributeGroup value. A fixed commission amount.

Parameters:

flatCommission -

getCommissionPayableAmount

public CurrencyAmountGroup getCommissionPayableAmount()

Get the 'CurrencyAmountGroup' attributeGroup value. The amount of commission to be paid.

Returns:

value

setCommissionPayableAmount

public void setCommissionPayableAmount(CurrencyAmountGroup commissionPayableAmount)

Set the 'CurrencyAmountGroup' attributeGroup value. The amount of commission to be paid.

Parameters:

commissionPayableAmount -

getComment

public Paragraph getComment()

Get the 'Comment' element value. Text related to the commission.

Returns:

value

setComment

public void setComment(Paragraph comment)

Set the 'Comment' element value. Text related to the commission.

Parameters:

comment -

getStatus

public Commission.Status getStatus()

Get the 'StatusType' attribute value. Indicates the status of the commission payment itself (e.g. no-show indicates that a different commission may be applied if the reservation is not fulfilled).

Returns:

value

setStatus

public void setStatus(Commission.Status status)

Set the 'StatusType' attribute value. Indicates the status of the commission payment itself (e.g. no-show indicates that a different commission may be applied if the reservation is not fulfilled).

Parameters:

status -

getPercent

public java.lang.Float getPercent()

Get the 'Percent' attribute value. The percent applied to the commissionable amount to determine the commission payable amount.

Returns:

value

setPercent

public void setPercent(java.lang.Float percent)

Set the 'Percent' attribute value. The percent applied to the commissionable amount to determine the commission payable amount.

Parameters:

percent -

getCurrencyCodeGroup

public CurrencyCodeGroup getCurrencyCodeGroup()

Get the 'CurrencyCodeGroup' attributeGroup value. Indicates the currency to be applied to the amounts located in the child elements.

Returns:

value

setCurrencyCodeGroup

public void setCurrencyCodeGroup(CurrencyCodeGroup currencyCodeGroup)

Set the 'CurrencyCodeGroup' attributeGroup value. Indicates the currency to be applied to the amounts located in the child elements.

Parameters:

currencyCodeGroup -

getReasonCode

public java.lang.String getReasonCode()

Get the 'ReasonCode' attribute value. Identifies the reason why a commission is not paid or not paid in full.

Returns:

value

setReasonCode

public void setReasonCode(java.lang.String reasonCode)

Set the 'ReasonCode' attribute value. Identifies the reason why a commission is not paid or not paid in full.

Parameters:

reasonCode -

getBillToID

public java.lang.String getBillToID()

Get the 'BillToID' attribute value. Identifies who should be billed for the commission amount.

Returns:

value

setBillToID

public void setBillToID(java.lang.String billToID)

Set the 'BillToID' attribute value. Identifies who should be billed for the commission amount.

Parameters:

billToID -

getFrequency

public java.lang.String getFrequency()

Get the 'Frequency' attribute value. This is the frequency at which the commission is applied (e.g. per stay, daily). Refer to OpenTravel Code List Charge Type (CHG).

Returns:

value

setFrequency

public void setFrequency(java.lang.String frequency)

Set the 'Frequency' attribute value. This is the frequency at which the commission is applied (e.g. per stay, daily). Refer to OpenTravel Code List Charge Type (CHG).

Parameters:

frequency -

getMaxCommissionUnitApplies

public java.lang.String getMaxCommissionUnitApplies()

Get the 'MaxCommissionUnitApplies' attribute value. Maximum number of units for which the commission will be applied. This may be used in conjunction with the frequency attribute.

Returns:

value

setMaxCommissionUnitApplies

public void setMaxCommissionUnitApplies(java.lang.String maxCommissionUnitApplies)

Set the 'MaxCommissionUnitApplies' attribute value. Maximum number of units for which the commission will be applied. This may be used in conjunction with the frequency attribute.

Parameters:

maxCommissionUnitApplies -

getCapAmount

public java.lang.Float getCapAmount()

Get the 'CapAmount' attribute value. The highest monetary value that may be paid for the commission.

Returns:

value

setCapAmount

public void setCapAmount(java.lang.Float capAmount)

Set the 'CapAmount' attribute value. The highest monetary value that may be paid for the commission.

Parameters:

capAmount -