org.cyclos.entities.banking

Class RateParameters

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.banking.RateParameters

All Implemented Interfaces:

java.lang.Cloneable, HasEntityImportance, ProcessableForDataTranslation, IEntity

Direct Known Subclasses:

TimeBasedRateParameters

@Entity
public abstract class RateParameters
extends BaseEntity

Base class for all rate parameters on the currency

Author:

rinke

Field Summary

Fields

Modifier and Type	Field and Description
protected java.math.BigDecimal	creationValue For most rate types the creation value is zero by definition, and it cannot be changed.

Constructor Summary

Constructors

Constructor and Description
RateParameters()

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getCreationValue()
Currency	getCurrency()
java.util.Date	getEndDate()
Network	getNetwork()
java.util.Date	getStartDate()
boolean	isActual() Returns if this RateParameters is the actual version.
boolean	isMarkedForResetting() reads the markedForResetting flag. If a rate is disabled, all accounts must be reset, that is: all rates connected to accounts must be set to null.
boolean	isShowToUser()
void	setCurrency(Currency currency)
void	setEndDate(java.util.Date endDate)
void	setMarkedForResetting(boolean markedForResetting) See isMarkedForResetting().
void	setShowToUser(boolean showToUser)
void	setStartDate(java.util.Date startDate)

Methods inherited from class org.cyclos.entities.BaseEntity

getDataTranslationType, getLogType, getVersion, isGlobal, isPersistent, isTransient

Methods inherited from class org.cyclos.entities.SimpleEntity

clone, equals, getEntityImportance, getId, getId, getIds, getUniqueIds, getUniqueIds, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

creationValue

protected java.math.BigDecimal creationValue

For most rate types the creation value is zero by definition, and it cannot be changed. For particular types it may be updateable, so there is no setter in this class, but subclasses may define a setter. That is also the reason it is protected and not private.

Constructor Detail

RateParameters

public RateParameters()

Method Detail

getCreationValue

public java.math.BigDecimal getCreationValue()

getCurrency

public Currency getCurrency()

getEndDate

public java.util.Date getEndDate()

getNetwork

public Network getNetwork()

Specified by:

getNetwork in class BaseEntity

Returns:

the network this entity belongs to

See Also:

BaseEntity.getNetwork()

getStartDate

public java.util.Date getStartDate()

isActual

public boolean isActual()

Returns if this RateParameters is the actual version. RateParameters is stored as a history log, so all old versions are kept. Only the actual version has an endDate which is null.

isMarkedForResetting

public boolean isMarkedForResetting()

reads the markedForResetting flag.
If a rate is disabled, all accounts must be reset, that is: all rates connected to accounts must be set to null. This is done via a background task. This flag is set to true as soon as an enabled rate is disabled. It is set back to false when the account resetting task has succesfully finished.

isShowToUser

public boolean isShowToUser()

setCurrency

public void setCurrency(Currency currency)

setEndDate

public void setEndDate(java.util.Date endDate)

setMarkedForResetting

public void setMarkedForResetting(boolean markedForResetting)

See isMarkedForResetting().

Parameters:

markedForResetting -

setShowToUser

public void setShowToUser(boolean showToUser)

setStartDate

public void setStartDate(java.util.Date startDate)