org.kuali.student.core.rate.dto

Class RateInfo

java.lang.Object

org.kuali.student.r2.common.dto.HasAttributesInfo

org.kuali.student.r2.common.dto.HasAttributesAndMetaInfo

org.kuali.student.r2.common.dto.TypeStateEntityInfo

org.kuali.student.r2.common.dto.EntityInfo

org.kuali.student.r2.common.dto.IdEntityInfo

org.kuali.student.core.rate.dto.RateInfo

All Implemented Interfaces:

Serializable, Rate, Entity, HasAttributes, HasAttributesAndMeta, HasId, HasMeta, HasPrimaryKey, HasState, HasType, IdEntity, TypeStateEntity

public class RateInfo
extends IdEntityInfo
implements Rate

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RateInfo() Constructs a new RateInfo.
RateInfo(Rate rate) Constructs a new RateInfo from another Rate.

Method Summary

Methods

Modifier and Type	Method and Description
CurrencyAmountInfo	getAmount() The amount for a flat or fixed unit rate.
String	getAtpId() The ATP for which this Rate is in effect.
String	getCatalogRateId() The CatalogRate identifier to which this Rate belongs.
List<FlexibleUnitAmountInfo>	getFlexibleUnitAmounts() The list of flexible unit amounts.
Boolean	getIsLimitRate() Tests if this is a "limit" rate.
CurrencyAmountInfo	getLimitAmount() Gets the amount for the limit when the number of units false in between the minimum and maximum limit range inclusive.
Integer	getMaximumLimitUnits() Gets the maximum, or high end of the unit range, for a limit rate.
Integer	getMinimumLimitUnits() Gets the minimum, or low end of the unit range, for a limit rate.
Date	getRecognitionDate() The recognition date used for rate processing.
String	getTransactionCode() The transaction code.
Date	getTransactionDate() The transaction date used for rate processing.
String	getTransactionDateTypeKey() The transaction date type key.
void	setAmount(CurrencyAmountInfo amount)
void	setAtpId(String atpId)
void	setCatalogRateId(String catalogRateId)
void	setFlexibleUnitAmounts(List<FlexibleUnitAmountInfo> flexibleUnitAmounts)
void	setIsLimitRate(Boolean isLimitRate)
void	setLimitAmount(CurrencyAmountInfo limitAmount)
void	setMaximumLimitUnits(Integer maximumLimitUnits)
void	setMinimumLimitUnits(Integer minimumLimitUnits)
void	setRecognitionDate(Date recognitionDate)
void	setTransactionCode(String transactionCode)
void	setTransactionDate(Date transactionDate)
void	setTransactionDateTypeKey(String transactionDateTypeKey)

Methods inherited from class org.kuali.student.r2.common.dto.IdEntityInfo

getId, setId

Methods inherited from class org.kuali.student.r2.common.dto.EntityInfo

getDescr, getName, setDescr, setName

Methods inherited from class org.kuali.student.r2.common.dto.TypeStateEntityInfo

getState, getStateKey, getType, getTypeKey, setState, setStateKey, setType, setTypeKey

Methods inherited from class org.kuali.student.r2.common.dto.HasAttributesAndMetaInfo

getMeta, setMeta

Methods inherited from class org.kuali.student.r2.common.dto.HasAttributesInfo

getAttributes, getAttributeValue, getAttributeValueList, setAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.student.r2.common.infc.HasId

getId

Methods inherited from interface org.kuali.student.r2.common.infc.Entity

getDescr, getName

Methods inherited from interface org.kuali.student.r2.common.infc.HasType

getType, getTypeKey

Methods inherited from interface org.kuali.student.r2.common.infc.HasState

getState, getStateKey

Methods inherited from interface org.kuali.student.r2.common.infc.HasAttributes

getAttributes

Methods inherited from interface org.kuali.student.r2.common.infc.HasMeta

getMeta

Constructor Detail

RateInfo

public RateInfo()

Constructs a new RateInfo.

RateInfo

public RateInfo(Rate rate)

Constructs a new RateInfo from another Rate.

Parameters:

rate - the Rate to copy

Method Detail

getCatalogRateId

public String getCatalogRateId()

Description copied from interface: Rate

The CatalogRate identifier to which this Rate belongs.

Specified by:

getCatalogRateId in interface Rate

Returns:

the catalog rate Id

setCatalogRateId

public void setCatalogRateId(String catalogRateId)

getAtpId

public String getAtpId()

Description copied from interface: Rate

The ATP for which this Rate is in effect. The ATP should be constrained by the list of applicable ATP Ids in the Rate Catalog. In the case of a Course Offering, this ATP is the same as (or a parent of) the Course Offering ATP.

Specified by:

getAtpId in interface Rate

Returns:

the ATP Id

setAtpId

public void setAtpId(String atpId)

getAmount

public CurrencyAmountInfo getAmount()

Description copied from interface: Rate

The amount for a flat or fixed unit rate. This amount should be constrained by the minimum and maxmimum range in the Rate Catalog for flat and fixed unit Rates.

Specified by:

getAmount in interface Rate

Returns:

the amount

setAmount

public void setAmount(CurrencyAmountInfo amount)

getFlexibleUnitAmounts

public List<FlexibleUnitAmountInfo> getFlexibleUnitAmounts()

Description copied from interface: Rate

The list of flexible unit amounts. This list should be constrained by the list of flexible unit amounts in the Rate Catalog.

Specified by:

getFlexibleUnitAmounts in interface Rate

Returns:

the list of flexible unit amounts

setFlexibleUnitAmounts

public void setFlexibleUnitAmounts(List<FlexibleUnitAmountInfo> flexibleUnitAmounts)

getTransactionDateTypeKey

public String getTransactionDateTypeKey()

Description copied from interface: Rate

The transaction date type key. The transaction date type can differ from the default type in the Rate Catalog of CatlogRate.canOverrideTransactionDateTypeKey is true.

Specified by:

getTransactionDateTypeKey in interface Rate

Returns:

the transaction date type key

setTransactionDateTypeKey

public void setTransactionDateTypeKey(String transactionDateTypeKey)

getTransactionCode

public String getTransactionCode()

Description copied from interface: Rate

The transaction code. The transaction code can differ from the default type in the Rate Catalog of CatlogRate.canOverrideTransactionCode is true.

Specified by:

getTransactionCode in interface Rate

Returns:

the transaction code

setTransactionCode

public void setTransactionCode(String transactionCode)

getTransactionDate

public Date getTransactionDate()

Description copied from interface: Rate

The transaction date used for rate processing.

Specified by:

getTransactionDate in interface Rate

Returns:

the transaction date

setTransactionDate

public void setTransactionDate(Date transactionDate)

getRecognitionDate

public Date getRecognitionDate()

Description copied from interface: Rate

The recognition date used for rate processing.

Specified by:

getRecognitionDate in interface Rate

Returns:

the recognition date

setRecognitionDate

public void setRecognitionDate(Date recognitionDate)

getIsLimitRate

public Boolean getIsLimitRate()

Description copied from interface: Rate

Tests if this is a "limit" rate. A limit rate has a minimum and maximum limit unit range at which the rate is the limitAmount.

Specified by:

getIsLimitRate in interface Rate

Returns:

true if this is a limit rate, false otherwise

setIsLimitRate

public void setIsLimitRate(Boolean isLimitRate)

getMinimumLimitUnits

public Integer getMinimumLimitUnits()

Description copied from interface: Rate

Gets the minimum, or low end of the unit range, for a limit rate. This field is only applicable if isLimitRate() is true.

Specified by:

getMinimumLimitUnits in interface Rate

Returns:

the low end of the limit units range

setMinimumLimitUnits

public void setMinimumLimitUnits(Integer minimumLimitUnits)

getMaximumLimitUnits

public Integer getMaximumLimitUnits()

Description copied from interface: Rate

Gets the maximum, or high end of the unit range, for a limit rate. This field is only applicable if isLimitRate() is true.

Specified by:

getMaximumLimitUnits in interface Rate

Returns:

the low end of the limit units range

setMaximumLimitUnits

public void setMaximumLimitUnits(Integer maximumLimitUnits)

getLimitAmount

public CurrencyAmountInfo getLimitAmount()

Description copied from interface: Rate

Gets the amount for the limit when the number of units false in between the minimum and maximum limit range inclusive.

Specified by:

getLimitAmount in interface Rate

Returns:

the limit amount

setLimitAmount

public void setLimitAmount(CurrencyAmountInfo limitAmount)