org.kuali.kpme.core.api.earncode

Interface EarnCodeContract

All Superinterfaces:

CreateTime, Effective, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, KpmeDataTransferObject, KpmeEffectiveDataTransferObject, UserModified, org.kuali.rice.core.api.mo.common.Versioned

All Known Implementing Classes:

EarnCode, EarnCode.Builder, EarnCodeBo

public interface EarnCodeContract
extends KpmeEffectiveDataTransferObject

EarnCodeContract interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
String	getAccrualBalanceAction() The action that can be taken for the balance of the AccrualCategory of an EarnCode
String	getAccrualCategory() The AccrualCategory name of the AccuralCategoryObject associated with an EarnCode
AccrualCategoryContract	getAccrualCategoryObj() The AccuralCategoryObject associated with an EarnCode
String	getAffectPay() Flag indicating use of this leave code will affect the employee's pay
String	getAllowNegativeAccrualBalance() Flag that allows usage to take the balance of the Accrual Category into the negative.
String	getAllowScheduledLeave() Flag indicating if scheduling of leave on calendar is allowed
String	getCountsAsRegularPay() The flag that indicates if the worked hours under an EarnCode should be counted as regular pay Use this field to calculate the "Worked Hours in the Time Summary.
Long	getDefaultAmountofTime() When a user selects leave code the specified amount of time will appear in the amount of leave taken.
String	getDescription() The description of an EarnCode
String	getEarnCode() The Alpha/Numeric code used to identify an EarnCode
String	getEarnCodeType() Indicates the record method time, hour or amount
String	getEligibleForAccrual() Flag indicating this type of leave is eligible for accrual or not
String	getFmla() FLMA Leave Code indicator.
String	getFractionalTimeAllowed() Defines fractional unit of time used for reporting leave
String	getHrEarnCodeId() The Primary Key of an EarnCode entry saved in a database
BigDecimal	getInflateFactor() The hours incurred will be multiplied by this factor
BigDecimal	getInflateMinHours() Hours incurred will be inflated to this minimum hours value
String	getLeavePlan() The name of the LeavePlan that this EarnCode associates with
String	getRecordMethod() The flag that determines the value type that will be entered for the earn code
String	getRollupToEarnCode() The earn code name of the EarnCode object that this EarnCode rolls up to
EarnCodeContract	getRollupToEarnCodeObj() The EarnCode Object that this EarnCode rolls up to
String	getRoundingOption() Indicated the rounding option when calculating leave accruals and reporting.
String	getUsageLimit() The flag that indicates if usage should be included or excluded toward the usage limit of the AccrualCategory associated with an EarnCode
String	getWorkmansComp() Workman's Comp Leave Code indicator.
boolean	isOvtEarnCode() Indicates this EarnCode may be used for overtime

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

isActive

Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

getId

Methods inherited from interface org.kuali.kpme.core.api.mo.Effective

getEffectiveLocalDate

Methods inherited from interface org.kuali.kpme.core.api.mo.CreateTime

getCreateTime

Methods inherited from interface org.kuali.kpme.core.api.mo.UserModified

getUserPrincipalId

Field Detail

CACHE_NAME

static final String CACHE_NAME

See Also:

Constant Field Values

Method Detail

getCountsAsRegularPay

String getCountsAsRegularPay()

The flag that indicates if the worked hours under an EarnCode should be counted as regular pay Use this field to calculate the "Worked Hours in the Time Summary.

countsAsRegularPay flag of EarnCode

Returns:

Y if has rules, N if not

getUsageLimit

String getUsageLimit()

The flag that indicates if usage should be included or excluded toward the usage limit of the AccrualCategory associated with an EarnCode

countsAsRegularPay flag of EarnCode

Returns:

I if Include, E if Exclude

getRecordMethod

String getRecordMethod()

The flag that determines the value type that will be entered for the earn code

recordMethod of EarnCode

Returns:

H for Hours, T for Time, D for Days, A for Amount

getRollupToEarnCode

String getRollupToEarnCode()

The earn code name of the EarnCode object that this EarnCode rolls up to

rollupToEarnCode of EarnCode

Returns:

rollupToEarnCode for EarnCode

getRollupToEarnCodeObj

EarnCodeContract getRollupToEarnCodeObj()

The EarnCode Object that this EarnCode rolls up to

rollupToEarnCodeObj of EarnCode

Returns:

rollupToEarnCodeObj for EarnCode

getLeavePlan

String getLeavePlan()

The name of the LeavePlan that this EarnCode associates with

leavePlan of EarnCode

Returns:

leavePlan for EarnCode

getAccrualBalanceAction

String getAccrualBalanceAction()

The action that can be taken for the balance of the AccrualCategory of an EarnCode

accrualBalanceAction of EarnCode

Returns:

N for None, U for usage, A for Adjustment

getFractionalTimeAllowed

String getFractionalTimeAllowed()

Defines fractional unit of time used for reporting leave

fractionalTimeAllowed of EarnCode

Returns:

fractionalTimeAllowed for EarnCode

getRoundingOption

String getRoundingOption()

Indicated the rounding option when calculating leave accruals and reporting.

roundingOption of EarnCode

Returns:

T for Traditional, R for Truncate

getEligibleForAccrual

String getEligibleForAccrual()

Flag indicating this type of leave is eligible for accrual or not

eligibleForAccrual of EarnCode

Returns:

Y for Yes, N for No

getAffectPay

String getAffectPay()

Flag indicating use of this leave code will affect the employee's pay

affectPay of EarnCode

Returns:

Y for Yes, N for No

getAllowScheduledLeave

String getAllowScheduledLeave()

Flag indicating if scheduling of leave on calendar is allowed

allowScheduledLeave of EarnCode

Returns:

Y for Yes, N for No

getFmla

String getFmla()

FLMA Leave Code indicator. If Principal Calendar is flagged for FMLA, employee will have option to select this Leave Code.

fmla flag of EarnCode

Returns:

Y for Yes, N for No

getWorkmansComp

String getWorkmansComp()

Workman's Comp Leave Code indicator. If Principal Calendar is flagged for Workman’s Comp, employee will have option to select this Leave Code.

workmansComp flag of EarnCode

Returns:

Y for Yes, N for No

getDefaultAmountofTime

Long getDefaultAmountofTime()

When a user selects leave code the specified amount of time will appear in the amount of leave taken.

defaultAmountofTime of EarnCode

Returns:

defaultAmountofTime for EarnCode

getAllowNegativeAccrualBalance

String getAllowNegativeAccrualBalance()

Flag that allows usage to take the balance of the Accrual Category into the negative.

allowNegativeAccrualBalance flag of EarnCode

Returns:

Y for Yes, N for No

getEarnCode

String getEarnCode()

The Alpha/Numeric code used to identify an EarnCode

earnCode of EarnCode

Returns:

earnCode for EarnCode

getDescription

String getDescription()

The description of an EarnCode

description of EarnCode

Returns:

description for EarnCode

getHrEarnCodeId

String getHrEarnCodeId()

The Primary Key of an EarnCode entry saved in a database

hrEarnCodeId of an EarnCode

Returns:

hrEarnCodeId for EarnCode

getAccrualCategory

String getAccrualCategory()

The AccrualCategory name of the AccuralCategoryObject associated with an EarnCode

accrualCategory of an EarnCode

Returns:

accrualCategory for EarnCode

getAccrualCategoryObj

AccrualCategoryContract getAccrualCategoryObj()

The AccuralCategoryObject associated with an EarnCode

accrualCategoryObj of an EarnCode

Returns:

accrualCategoryObj for EarnCode

getInflateMinHours

BigDecimal getInflateMinHours()

Hours incurred will be inflated to this minimum hours value

inflateMinHours of an EarnCode

Returns:

inflateMinHours for EarnCode

getInflateFactor

BigDecimal getInflateFactor()

The hours incurred will be multiplied by this factor

InflateFactor of an EarnCode

Returns:

InflateFactor for EarnCode

isOvtEarnCode

boolean isOvtEarnCode()

Indicates this EarnCode may be used for overtime

ovtEarnCode flag of an EarnCode

Returns:

Y for Yes, N for No

getEarnCodeType

String getEarnCodeType()

Indicates the record method time, hour or amount

recordmethod of an EarnCode

Returns: