org.otfeed.event
Class OTDividend

java.lang.Object
  org.otfeed.event.OTDividend

All Implemented Interfaces:

java.lang.Comparable<OTDividend>

public final class OTDividend
extends java.lang.Object
implements java.lang.Comparable<OTDividend>

This class provides OTDividend events and member functions to reference the data provided by the object.

Constructor Summary

OTDividend()
Default constructor.

OTDividend(double price, java.util.Date declaratonDate, java.util.Date executionDate, java.util.Date recordDate, java.util.Date paymentDate, java.util.Set<DividendPropertyEnum> properties)
Constructor.

Method Summary

int	compareTo(OTDividend other)
boolean	equals(java.lang.Object o)
java.util.Date	getDeclarationDate()
java.util.Date	getExecutionDate()
java.util.Date	getPaymentDate()
double	getPrice()
java.util.Set<DividendPropertyEnum>	getProperties()
java.util.Date	getRecordDate()
int	hashCode()
boolean	isAnnual()
boolean	isApproximate()
boolean	isCanadian()
boolean	isExtra()
boolean	isFinal()
boolean	isIncrease()
boolean	isSemiannual()
boolean	isSpecial()
boolean	isStock()
void	setDeclarationDate(java.util.Date declarationDate) Sets declaration date.
void	setExecutionDate(java.util.Date executionDate) Sets execution date.
void	setPaymentDate(java.util.Date paymentDate) Sets payment date.
void	setPrice(double price) Sets dividend (value).
void	setProperties(java.util.Set<DividendPropertyEnum> val)
void	setRecordDate(java.util.Date recordDate) Sets record date.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OTDividend

public OTDividend()

Default constructor.

OTDividend

public OTDividend(double price,
                  java.util.Date declaratonDate,
                  java.util.Date executionDate,
                  java.util.Date recordDate,
                  java.util.Date paymentDate,
                  java.util.Set<DividendPropertyEnum> properties)

Constructor.

Parameters:

price - Dividend (value).

declaratonDate - Declaration date.

executionDate - Execution date.

recordDate - Record date.

paymentDate - Payment date.

properties - set of properties, see DividendPropertyEnum

Method Detail

getPrice

public double getPrice()

Returns:

Dividend (value).

setPrice

public void setPrice(double price)

Sets dividend (value).

Parameters:

price - Dividend (value).

getDeclarationDate

public java.util.Date getDeclarationDate()

Returns:

Date of declaration.

setDeclarationDate

public void setDeclarationDate(java.util.Date declarationDate)

Sets declaration date.

Parameters:

declarationDate - Declaration date.

getExecutionDate

public java.util.Date getExecutionDate()

Returns:

Date of execution.

setExecutionDate

public void setExecutionDate(java.util.Date executionDate)

Sets execution date.

Parameters:

executionDate - Execution date.

getRecordDate

public java.util.Date getRecordDate()

Returns:

Date of record.

setRecordDate

public void setRecordDate(java.util.Date recordDate)

Sets record date.

Parameters:

recordDate - Record date.

getPaymentDate

public java.util.Date getPaymentDate()

Returns:

Date of payment.

setPaymentDate

public void setPaymentDate(java.util.Date paymentDate)

Sets payment date.

Parameters:

paymentDate - Payment date.

getProperties

public java.util.Set<DividendPropertyEnum> getProperties()

Returns:

Set of properties, see DividendPropertyEnum.

setProperties

public void setProperties(java.util.Set<DividendPropertyEnum> val)

isApproximate

public boolean isApproximate()

Returns:

Is approximate.

isAnnual

public boolean isAnnual()

Returns:

Is annual.

isCanadian

public boolean isCanadian()

Returns:

Is canadian.

isExtra

public boolean isExtra()

Returns:

Is extra.

isFinal

public boolean isFinal()

Returns:

Is final.

isIncrease

public boolean isIncrease()

Returns:

Is increase.

isSemiannual

public boolean isSemiannual()

Returns:

IS semiannual.

isStock

public boolean isStock()

Returns:

Is stock.

isSpecial

public boolean isSpecial()

Returns:

Is special.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(OTDividend other)

Specified by:

compareTo in interface java.lang.Comparable<OTDividend>