org.kuali.kfs.module.endow.businessobject
Class Security

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.kfs.module.endow.businessobject.Security

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.Inactivateable, org.kuali.rice.kns.bo.PersistableBusinessObject

public class Security
extends org.kuali.rice.kns.bo.PersistableBusinessObjectBase
implements org.kuali.rice.kns.bo.Inactivateable

Business Object for Security table.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Security()
Constructs a Security.java.

Method Summary

void	afterLookup(org.apache.ojb.broker.PersistenceBroker persistenceBroker)
BigDecimal	getCarryValue() This method gets carryValue
ClassCode	getClassCode() This method gets the classCode.
String	getCodeAndDescription() Gets the codeAndDescription text
BigDecimal	getCommitmentAmount() This method gets the commitmentAmount.
String	getCurrentHolders() Gets the CurrentHolders link text
String	getDescription() This method gets the description.
BigDecimal	getDividendAmount() This method gets the dividendAmount.
Date	getDividendPayDate() This method gets the dividendPayDate
Date	getDividendRecordDate() This method gets the dividendRecordDate.
Date	getExDividendDate() This method gets the exDividendDate.
FrequencyCode	getFrequencyCode() This method returns the frequencyCode.
String	getHoldersInHistory() Gets the HoldersInHistory link text
String	getId() This method gets the id.
Date	getIncomeChangeDate() This method gets the incomeChangeDate.
Date	getIncomeNextPayDate() This method gets the incomeNextPayDate
String	getIncomePayFrequency() This method gets the incomePayFrequency.
BigDecimal	getIncomeRate() This method gets the incomeRate
Date	getIssueDate() This method gets the incomeRate.
Date	getLastTransactionDate() This method gets the lastTransactionDate.
BigDecimal	getMarketValue() This method gets the market value of the security.
Date	getMaturityDate() This method gets the maturityDate
BigDecimal	getNextFiscalYearDistributionAmount() Gets the nextFiscalYearDistributionAmount.
BigDecimal	getPreviousUnitValue() This method gets the previousUnitValue.
Date	getPreviousUnitValueDate() This method gets the previousUnitValueDate.
String	getSecurityClassCode() This method gets the securityClassCode
String	getSecurityIdDescription()
String	getSecuritySubclassCode() This method gets the securitySubclassCode
BigDecimal	getSecurityValueByMarket() Gets the securityValueByMarket.
SubclassCode	getSubclassCode() This method gets the subclassCode.
String	getTickerSymbol() This method gets the tickerSymbol.
List<Tickler>	getTicklers() Gets the active ticklers for this Security.
BigDecimal	getUnitsHeld() This method gets the unitsHeld.
BigDecimal	getUnitValue() This method gets the unitValue.
String	getUnitValueSource() This method gets the unitValueSource.
String	getUserEnteredSecurityIDprefix() This method gets the user entered security ID prefix (first 8 characters).
Date	getValuationDate() This method gets the valuationDate.
boolean	isActive()
void	setActive(boolean active)
void	setCarryValue(BigDecimal carryValue) This method sets carryValue.
void	setClassCode(ClassCode classCode) This method sets the classCode.
void	setCommitmentAmount(BigDecimal commitmentAmount) This method sets the commitmentAmount.
void	setDescription(String description) This method sets the description.
void	setDividendAmount(BigDecimal dividendAmount) This method sets the dividendAmount.
void	setDividendPayDate(Date dividendPayDate) This method sets the dividendPayDate.
void	setDividendRecordDate(Date dividendRecordDate) This method sets the dividendRecordDate.
void	setExDividendDate(Date exDividendDate) This method sets the exDividendDate.
void	setFrequencyCode(FrequencyCode frequencyCode) This method sets the frequencyCode.
void	setId(String id) This method sets the id.
void	setIncomeChangeDate(Date incomeChangeDate) This method sets the incomeChangeDate.
void	setIncomeNextPayDate(Date incomeNextPayDate) This method sets the incomeNextPayDate
void	setIncomePayFrequency(String incomePayFrequency) This method sets the incomePayFrequency
void	setIncomeRate(BigDecimal incomeRate) This method sets the incomeRate
void	setIssueDate(Date issueDate) This method sets the incomeRate.
void	setLastTransactionDate(Date lastTransactionDate) This method sets the lastTransactionDate.
void	setMarketValue(BigDecimal marketValue) This method sete the marketValue for the security.
void	setMaturityDate(Date maturityDate) This method sets the maturityDate
void	setNextFiscalYearDistributionAmount(BigDecimal nextFiscalYearDistributionAmount) Sets the nextFiscalYearDistributionAmount.
void	setPreviousUnitValue(BigDecimal previousUnitValue) This method sets the previousUnitValue.
void	setPreviousUnitValueDate(Date previousUnitValueDate) This method sets previousUnitValueDate.
void	setSecurityClassCode(String securityClassCode) This method sets the securityClassCode.
void	setSecuritySubclassCode(String subclassCode) This method sets the securitySubclassCode
void	setSecurityValueByMarket(BigDecimal securityValueByMarket) Sets the securityValueByMarket.
void	setSubclassCode(SubclassCode subclassCode) This method sets the subclassCode.
void	setTickerSymbol(String tickerSymbol) This method sets the tickerSymbol.
void	setTicklers(List<Tickler> ticklers) Sets the ticklers.
void	setUnitsHeld(BigDecimal unitsHeld) This method sets the unitsHeld.
void	setUnitValue(BigDecimal unitValue) This method sets the unitValue.
void	setUnitValueSource(String unitValueSource) This method sets the unitValueSource.
void	setUserEnteredSecurityIDprefix(String userEnteredSecurityIDprefix) This method sets the user entered security ID prefix.
void	setValuationDate(Date valuationDate) This method sets the valuationDate.
protected LinkedHashMap	toStringMapper()

Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

addNote, afterDelete, afterInsert, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, buildListOfDeletionAwareLists, deleteNote, getAttachmentService, getBoNote, getBoNotes, getExtension, getNoteService, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isAutoIncrementSet, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setBoNotes, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber, supportsBoNotes

Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase

prepareForWorkflow, toString, toStringBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.kns.bo.BusinessObject

prepareForWorkflow

Constructor Detail

Security

public Security()

Constructs a Security.java.

Method Detail

toStringMapper

protected LinkedHashMap toStringMapper()

Specified by:

toStringMapper in class org.kuali.rice.kns.bo.BusinessObjectBase

See Also:

BusinessObjectBase.toStringMapper()

isActive

public boolean isActive()

Specified by:

isActive in interface org.kuali.rice.kns.bo.Inactivateable

See Also:

Inactivateable.isActive()

setActive

public void setActive(boolean active)

Specified by:

setActive in interface org.kuali.rice.kns.bo.Inactivateable

See Also:

Inactivateable.setActive(boolean)

getCarryValue

public BigDecimal getCarryValue()

This method gets carryValue

Returns:

carryValue

setCarryValue

public void setCarryValue(BigDecimal carryValue)

This method sets carryValue.

Parameters:

carryValue -

getCommitmentAmount

public BigDecimal getCommitmentAmount()

This method gets the commitmentAmount.

Returns:

commitmentAmount

setCommitmentAmount

public void setCommitmentAmount(BigDecimal commitmentAmount)

This method sets the commitmentAmount.

Parameters:

commitmentAmount -

getDescription

public String getDescription()

This method gets the description.

Returns:

description

setDescription

public void setDescription(String description)

This method sets the description.

Parameters:

description -

getDividendAmount

public BigDecimal getDividendAmount()

This method gets the dividendAmount.

Returns:

dividendAmount

setDividendAmount

public void setDividendAmount(BigDecimal dividendAmount)

This method sets the dividendAmount.

Parameters:

dividendAmount -

getDividendPayDate

public Date getDividendPayDate()

This method gets the dividendPayDate

Returns:

dividendPayDate

setDividendPayDate

public void setDividendPayDate(Date dividendPayDate)

This method sets the dividendPayDate.

Parameters:

dividendPayDate -

getDividendRecordDate

public Date getDividendRecordDate()

This method gets the dividendRecordDate.

Returns:

dividendRecordDate

setDividendRecordDate

public void setDividendRecordDate(Date dividendRecordDate)

This method sets the dividendRecordDate.

Parameters:

dividendRecordDate -

getExDividendDate

public Date getExDividendDate()

This method gets the exDividendDate.

Returns:

exDividendDate

setExDividendDate

public void setExDividendDate(Date exDividendDate)

This method sets the exDividendDate.

Parameters:

exDividendDate -

getId

public String getId()

This method gets the id.

Returns:

id

setId

public void setId(String id)

This method sets the id.

Parameters:

id -

getIncomeChangeDate

public Date getIncomeChangeDate()

This method gets the incomeChangeDate.

Returns:

incomeChangeDate

setIncomeChangeDate

public void setIncomeChangeDate(Date incomeChangeDate)

This method sets the incomeChangeDate.

Parameters:

incomeChangeDate -

getIncomeNextPayDate

public Date getIncomeNextPayDate()

This method gets the incomeNextPayDate

Returns:

incomeNextPayDate

setIncomeNextPayDate

public void setIncomeNextPayDate(Date incomeNextPayDate)

This method sets the incomeNextPayDate

Parameters:

incomeNextPayDate -

getIncomePayFrequency

public String getIncomePayFrequency()

This method gets the incomePayFrequency.

Returns:

incomePayFrequency

setIncomePayFrequency

public void setIncomePayFrequency(String incomePayFrequency)

This method sets the incomePayFrequency

Parameters:

incomePayFrequency -

getIncomeRate

public BigDecimal getIncomeRate()

This method gets the incomeRate

Returns:

incomeRate

setIncomeRate

public void setIncomeRate(BigDecimal incomeRate)

This method sets the incomeRate

Parameters:

incomeRate -

getIssueDate

public Date getIssueDate()

This method gets the incomeRate.

Returns:

incomeRate

setIssueDate

public void setIssueDate(Date issueDate)

This method sets the incomeRate.

Parameters:

issueDate -

getLastTransactionDate

public Date getLastTransactionDate()

This method gets the lastTransactionDate.

Returns:

lastTransactionDate

setLastTransactionDate

public void setLastTransactionDate(Date lastTransactionDate)

This method sets the lastTransactionDate.

Parameters:

lastTransactionDate -

getMaturityDate

public Date getMaturityDate()

This method gets the maturityDate

Returns:

maturityDate

setMaturityDate

public void setMaturityDate(Date maturityDate)

This method sets the maturityDate

Parameters:

maturityDate -

getSecuritySubclassCode

public String getSecuritySubclassCode()

This method gets the securitySubclassCode

Returns:

securitySubclassCode

setSecuritySubclassCode

public void setSecuritySubclassCode(String subclassCode)

This method sets the securitySubclassCode

Parameters:

subclassCode -

getTickerSymbol

public String getTickerSymbol()

This method gets the tickerSymbol.

Returns:

the tickerSymbol

setTickerSymbol

public void setTickerSymbol(String tickerSymbol)

This method sets the tickerSymbol.

Parameters:

tickerSymbol -

getUnitsHeld

public BigDecimal getUnitsHeld()

This method gets the unitsHeld.

Returns:

unitsHeld

setUnitsHeld

public void setUnitsHeld(BigDecimal unitsHeld)

This method sets the unitsHeld.

Parameters:

unitsHeld -

getUnitValue

public BigDecimal getUnitValue()

This method gets the unitValue.

Returns:

unitValue

setUnitValue

public void setUnitValue(BigDecimal unitValue)

This method sets the unitValue.

Parameters:

unitValue -

getValuationDate

public Date getValuationDate()

This method gets the valuationDate.

Returns:

valuationDate

setValuationDate

public void setValuationDate(Date valuationDate)

This method sets the valuationDate.

Parameters:

valuationDate -

getPreviousUnitValue

public BigDecimal getPreviousUnitValue()

This method gets the previousUnitValue.

Returns:

previousUnitValue

setPreviousUnitValue

public void setPreviousUnitValue(BigDecimal previousUnitValue)

This method sets the previousUnitValue.

Parameters:

previousUnitValue -

getPreviousUnitValueDate

public Date getPreviousUnitValueDate()

This method gets the previousUnitValueDate.

Returns:

previousUnitValueDate

setPreviousUnitValueDate

public void setPreviousUnitValueDate(Date previousUnitValueDate)

This method sets previousUnitValueDate.

Parameters:

previousUnitValueDate -

getUnitValueSource

public String getUnitValueSource()

This method gets the unitValueSource.

Returns:

unitValueSource

setUnitValueSource

public void setUnitValueSource(String unitValueSource)

This method sets the unitValueSource.

Parameters:

unitValueSource -

getClassCode

public ClassCode getClassCode()

This method gets the classCode.

Returns:

classCode

setClassCode

public void setClassCode(ClassCode classCode)

This method sets the classCode.

Parameters:

classCode -

getSecurityClassCode

public String getSecurityClassCode()

This method gets the securityClassCode

Returns:

securityClassCode

setSecurityClassCode

public void setSecurityClassCode(String securityClassCode)

This method sets the securityClassCode.

Parameters:

securityClassCode -

getFrequencyCode

public FrequencyCode getFrequencyCode()

This method returns the frequencyCode.

Returns:

frequencyCode

setFrequencyCode

public void setFrequencyCode(FrequencyCode frequencyCode)

This method sets the frequencyCode.

Parameters:

frequencyCode -

getSubclassCode

public SubclassCode getSubclassCode()

This method gets the subclassCode.

Returns:

subclassCode

setSubclassCode

public void setSubclassCode(SubclassCode subclassCode)

This method sets the subclassCode.

Parameters:

subclassCode -

getUserEnteredSecurityIDprefix

public String getUserEnteredSecurityIDprefix()

This method gets the user entered security ID prefix (first 8 characters).

Returns:

setUserEnteredSecurityIDprefix

public void setUserEnteredSecurityIDprefix(String userEnteredSecurityIDprefix)

This method sets the user entered security ID prefix.

Parameters:

userEnteredSecurityIDprefix -

getMarketValue

public BigDecimal getMarketValue()

This method gets the market value of the security.

Returns:

marketValue

setMarketValue

public void setMarketValue(BigDecimal marketValue)

This method sete the marketValue for the security.

Parameters:

marketValue -

afterLookup

public void afterLookup(org.apache.ojb.broker.PersistenceBroker persistenceBroker)
                 throws org.apache.ojb.broker.PersistenceBrokerException

Specified by:

afterLookup in interface org.apache.ojb.broker.PersistenceBrokerAware

Overrides:

afterLookup in class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

Throws:

org.apache.ojb.broker.PersistenceBrokerException

See Also:

PersistableBusinessObjectBase.afterLookup(org.apache.ojb.broker.PersistenceBroker)

getNextFiscalYearDistributionAmount

public BigDecimal getNextFiscalYearDistributionAmount()

Gets the nextFiscalYearDistributionAmount.

Returns:

nextFiscalYearDistributionAmount

setNextFiscalYearDistributionAmount

public void setNextFiscalYearDistributionAmount(BigDecimal nextFiscalYearDistributionAmount)

Sets the nextFiscalYearDistributionAmount.

Parameters:

nextFiscalYearDistributionAmount -

getCurrentHolders

public String getCurrentHolders()

Gets the CurrentHolders link text

Returns:

the text to be displayed for the current holders link.

getHoldersInHistory

public String getHoldersInHistory()

Gets the HoldersInHistory link text

Returns:

the text to be displayed for the holders in history link.

getSecurityIdDescription

public String getSecurityIdDescription()

getCodeAndDescription

public String getCodeAndDescription()

Gets the codeAndDescription text

Returns:

the code and description in the form: xx-xxxxxxxxxx

getTicklers

public List<Tickler> getTicklers()

Gets the active ticklers for this Security.

Returns:

ticklers

setTicklers

public void setTicklers(List<Tickler> ticklers)

Sets the ticklers.

Parameters:

ticklers -

getSecurityValueByMarket

public BigDecimal getSecurityValueByMarket()

Gets the securityValueByMarket.

Returns:

securityValueByMarket

setSecurityValueByMarket

public void setSecurityValueByMarket(BigDecimal securityValueByMarket)

Sets the securityValueByMarket.

Parameters:

securityValueByMarket -