org.kuali.student.core.rate.infc

Interface Rate

All Superinterfaces:

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

All Known Implementing Classes:

RateInfo

public interface Rate
extends IdEntity

The Rate is drawn from the CatalogRate and applied to something (ref object) with a charge, like a CourseOffering. The CatalogRate constrains the Rate. The Rate has one of three flavors indicated by its Type:

Flat

A rate that doesn't vary. The amount is constrained by the minimum and maximum amount range in the Rate Catalog.

Fixed Credit

A rate per credit where the total amount is the rate multiplied by the credits (or units) determined by what this Rate applies to. The amount is constrained by the minimum and maximum amount range in the Rate Catalog.

Flexible Credit

A specific rate for each credit value. The list of flexible credit amounts is constrained by the list of acceptable credits amounts in the Rate Catalog.

Author:

Kuali Student Services

Method Summary

Methods

Modifier and Type	Method and Description
CurrencyAmount	getAmount() The amount for a flat or fixed credit rate.
String	getAtpId() The ATP for which this Rate is in effect.
String	getCatalogRateId() The CatalogRate identifier to which this Rate belongs.
List<? extends FlexibleCreditAmount>	getFlexibleCreditAmounts() The list of flexible credit amounts.
List<String>	getRefObjectIds() The identifier of the reference objects to which this Rate applies.
String	getRefObjectURI() The URI of the reference object to which this Rate applies.
String	getTransactionCode() The transaction code.
Date	getTransactionDate() The transaction date used for rate processing.
String	getTransactionDateTypeKey() The transaction date type key.

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

Method Detail

getCatalogRateId

String getCatalogRateId()

The CatalogRate identifier to which this Rate belongs.

Returns:

the catalog rate Id

getRefObjectURI

String getRefObjectURI()

The URI of the reference object to which this Rate applies.

Returns:

the URI

getRefObjectIds

List<String> getRefObjectIds()

The identifier of the reference objects to which this Rate applies. There may be multiple references, but all of the same type as indicated by the reference object URI.

Returns:

the Ids of the reference objects

getAtpId

String getAtpId()

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.

Returns:

the ATP Id

getAmount

CurrencyAmount getAmount()

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

Returns:

the amount

getFlexibleCreditAmounts

List<? extends FlexibleCreditAmount> getFlexibleCreditAmounts()

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

Returns:

the list of flexible credit amounts

getTransactionCode

String getTransactionCode()

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

Returns:

the transaction code

getTransactionDate

Date getTransactionDate()

The transaction date used for rate processing.

Returns:

the transaction date

getTransactionDateTypeKey

String getTransactionDateTypeKey()

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

Returns:

the transaction date type key