org.kuali.kpme.core.api.earncode

Class EarnCode

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.kpme.core.api.earncode.EarnCode

All Implemented Interfaces:

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

public final class EarnCode
extends org.kuali.rice.core.api.mo.AbstractDataTransferObject
implements EarnCodeContract

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EarnCode.Builder A builder which can be used to construct EarnCode instances.

Field Summary

Fields inherited from interface org.kuali.kpme.core.api.earncode.EarnCodeContract

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
AccrualCategory	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.
org.joda.time.DateTime	getCreateTime() The timestamp of when this HrBusinessObject was last created/updated
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
org.joda.time.LocalDate	getEffectiveLocalDate() The localDate format of the effective date of the HrBusinessObject
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
String	getId()
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	getObjectId()
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
EarnCode	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	getUserPrincipalId() The userPrincipalId of when this HrBusinessObject was last created/updated
Long	getVersionNumber()
String	getWorkmansComp() Workman's Comp Leave Code indicator.
boolean	isActive()
boolean	isOvtEarnCode() Indicates this EarnCode may be used for overtime

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

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

Method Detail

getAccrualBalanceAction

public String getAccrualBalanceAction()

Description copied from interface: EarnCodeContract

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

accrualBalanceAction of EarnCode

Specified by:

getAccrualBalanceAction in interface EarnCodeContract

Returns:

N for None, U for usage, A for Adjustment

getFractionalTimeAllowed

public String getFractionalTimeAllowed()

Description copied from interface: EarnCodeContract

Defines fractional unit of time used for reporting leave

fractionalTimeAllowed of EarnCode

Specified by:

getFractionalTimeAllowed in interface EarnCodeContract

Returns:

fractionalTimeAllowed for EarnCode

getRoundingOption

public String getRoundingOption()

Description copied from interface: EarnCodeContract

Indicated the rounding option when calculating leave accruals and reporting.

roundingOption of EarnCode

Specified by:

getRoundingOption in interface EarnCodeContract

Returns:

T for Traditional, R for Truncate

getEligibleForAccrual

public String getEligibleForAccrual()

Description copied from interface: EarnCodeContract

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

eligibleForAccrual of EarnCode

Specified by:

getEligibleForAccrual in interface EarnCodeContract

Returns:

Y for Yes, N for No

getAffectPay

public String getAffectPay()

Description copied from interface: EarnCodeContract

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

affectPay of EarnCode

Specified by:

getAffectPay in interface EarnCodeContract

Returns:

Y for Yes, N for No

getAllowScheduledLeave

public String getAllowScheduledLeave()

Description copied from interface: EarnCodeContract

Flag indicating if scheduling of leave on calendar is allowed

allowScheduledLeave of EarnCode

Specified by:

getAllowScheduledLeave in interface EarnCodeContract

Returns:

Y for Yes, N for No

getFmla

public String getFmla()

Description copied from interface: EarnCodeContract

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

fmla flag of EarnCode

Specified by:

getFmla in interface EarnCodeContract

Returns:

Y for Yes, N for No

getWorkmansComp

public String getWorkmansComp()

Description copied from interface: EarnCodeContract

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

Specified by:

getWorkmansComp in interface EarnCodeContract

Returns:

Y for Yes, N for No

getDefaultAmountofTime

public Long getDefaultAmountofTime()

Description copied from interface: EarnCodeContract

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

defaultAmountofTime of EarnCode

Specified by:

getDefaultAmountofTime in interface EarnCodeContract

Returns:

defaultAmountofTime for EarnCode

getAllowNegativeAccrualBalance

public String getAllowNegativeAccrualBalance()

Description copied from interface: EarnCodeContract

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

allowNegativeAccrualBalance flag of EarnCode

Specified by:

getAllowNegativeAccrualBalance in interface EarnCodeContract

Returns:

Y for Yes, N for No

getEarnCode

public String getEarnCode()

Description copied from interface: EarnCodeContract

The Alpha/Numeric code used to identify an EarnCode

earnCode of EarnCode

Specified by:

getEarnCode in interface EarnCodeContract

Returns:

earnCode for EarnCode

getDescription

public String getDescription()

Description copied from interface: EarnCodeContract

The description of an EarnCode

description of EarnCode

Specified by:

getDescription in interface EarnCodeContract

Returns:

description for EarnCode

getHrEarnCodeId

public String getHrEarnCodeId()

Description copied from interface: EarnCodeContract

The Primary Key of an EarnCode entry saved in a database

hrEarnCodeId of an EarnCode

Specified by:

getHrEarnCodeId in interface EarnCodeContract

Returns:

hrEarnCodeId for EarnCode

getAccrualCategory

public String getAccrualCategory()

Description copied from interface: EarnCodeContract

The AccrualCategory name of the AccuralCategoryObject associated with an EarnCode

accrualCategory of an EarnCode

Specified by:

getAccrualCategory in interface EarnCodeContract

Returns:

accrualCategory for EarnCode

getAccrualCategoryObj

public AccrualCategory getAccrualCategoryObj()

Description copied from interface: EarnCodeContract

The AccuralCategoryObject associated with an EarnCode

accrualCategoryObj of an EarnCode

Specified by:

getAccrualCategoryObj in interface EarnCodeContract

Returns:

accrualCategoryObj for EarnCode

getInflateMinHours

public BigDecimal getInflateMinHours()

Description copied from interface: EarnCodeContract

Hours incurred will be inflated to this minimum hours value

inflateMinHours of an EarnCode

Specified by:

getInflateMinHours in interface EarnCodeContract

Returns:

inflateMinHours for EarnCode

getRollupToEarnCode

public String getRollupToEarnCode()

Description copied from interface: EarnCodeContract

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

rollupToEarnCode of EarnCode

Specified by:

getRollupToEarnCode in interface EarnCodeContract

Returns:

rollupToEarnCode for EarnCode

getLeavePlan

public String getLeavePlan()

Description copied from interface: EarnCodeContract

The name of the LeavePlan that this EarnCode associates with

leavePlan of EarnCode

Specified by:

getLeavePlan in interface EarnCodeContract

Returns:

leavePlan for EarnCode

getRollupToEarnCodeObj

public EarnCode getRollupToEarnCodeObj()

Description copied from interface: EarnCodeContract

The EarnCode Object that this EarnCode rolls up to

rollupToEarnCodeObj of EarnCode

Specified by:

getRollupToEarnCodeObj in interface EarnCodeContract

Returns:

rollupToEarnCodeObj for EarnCode

getCountsAsRegularPay

public String getCountsAsRegularPay()

Description copied from interface: EarnCodeContract

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

Specified by:

getCountsAsRegularPay in interface EarnCodeContract

Returns:

Y if has rules, N if not

getUsageLimit

public String getUsageLimit()

Description copied from interface: EarnCodeContract

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

Specified by:

getUsageLimit in interface EarnCodeContract

Returns:

I if Include, E if Exclude

getRecordMethod

public String getRecordMethod()

Description copied from interface: EarnCodeContract

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

recordMethod of EarnCode

Specified by:

getRecordMethod in interface EarnCodeContract

Returns:

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

getInflateFactor

public BigDecimal getInflateFactor()

Description copied from interface: EarnCodeContract

The hours incurred will be multiplied by this factor

InflateFactor of an EarnCode

Specified by:

getInflateFactor in interface EarnCodeContract

Returns:

InflateFactor for EarnCode

isOvtEarnCode

public boolean isOvtEarnCode()

Description copied from interface: EarnCodeContract

Indicates this EarnCode may be used for overtime

ovtEarnCode flag of an EarnCode

Specified by:

isOvtEarnCode in interface EarnCodeContract

Returns:

Y for Yes, N for No

getEarnCodeType

public String getEarnCodeType()

Description copied from interface: EarnCodeContract

Indicates the record method time, hour or amount

recordmethod of an EarnCode

Specified by:

getEarnCodeType in interface EarnCodeContract

Returns:

getVersionNumber

public Long getVersionNumber()

Specified by:

getVersionNumber in interface org.kuali.rice.core.api.mo.common.Versioned

getObjectId

public String getObjectId()

Specified by:

getObjectId in interface org.kuali.rice.core.api.mo.common.GloballyUnique

isActive

public boolean isActive()

Specified by:

isActive in interface org.kuali.rice.core.api.mo.common.active.Inactivatable

getId

public String getId()

Specified by:

getId in interface org.kuali.rice.core.api.mo.common.Identifiable

getEffectiveLocalDate

public org.joda.time.LocalDate getEffectiveLocalDate()

Description copied from interface: Effective

The localDate format of the effective date of the HrBusinessObject

effectiveLocalDate of HrBusinessObject

Specified by:

getEffectiveLocalDate in interface Effective

Returns:

effectiveLocalDate of HrBusinessObject

getCreateTime

public org.joda.time.DateTime getCreateTime()

Description copied from interface: CreateTime

The timestamp of when this HrBusinessObject was last created/updated

timestamp of HrBusinessObject

Specified by:

getCreateTime in interface CreateTime

Returns:

timestamp of HrBusinessObject

getUserPrincipalId

public String getUserPrincipalId()

Description copied from interface: UserModified

The userPrincipalId of when this HrBusinessObject was last created/updated

userPrincipalId of HrBusinessObject

Specified by:

getUserPrincipalId in interface UserModified

Returns:

userPrincipalId of HrBusinessObject