org.kuali.kpme.core.earncode
Class EarnCode

java.lang.Object
  org.kuali.rice.krad.bo.BusinessObjectBase
      org.kuali.rice.krad.bo.PersistableBusinessObjectBase
          org.kuali.kpme.core.bo.HrBusinessObject
              org.kuali.kpme.core.earncode.EarnCode

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, HrBusinessObjectContract, EarnCodeContract, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject

public class EarnCode
extends HrBusinessObject
implements EarnCodeContract

See Also:

Serialized Form

Field Summary

static com.google.common.collect.ImmutableList<String>	CACHE_FLUSH
static String	CACHE_NAME
static com.google.common.collect.ImmutableList<String>	EQUAL_TO_FIELDS

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

EarnCode()

Method Summary

void	assingAccrualCategoryObj()
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.
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	getEarnCodeKeyForDisplay()
String	getEarnCodeType() This is used by the timeblock json object.
String	getEarnCodeValueForDisplay()
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() The unique id defined by the object, could be a combination of multiple fields
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
LeavePlan	getLeavePlanObj() The LeavePlan object associated with an EarnCode
Boolean	getOvtEarnCode() Indicates this EarnCode may be used for overtime
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	getUniqueKey()
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	isHistory() The history flag of an EarnCode
void	setAccrualBalanceAction(String accrualBalanceAction)
void	setAccrualCategory(String accrualCategory)
void	setAccrualCategoryObj(AccrualCategory accrualCategoryObj)
void	setAffectPay(String affectPay)
void	setAllowNegativeAccrualBalance(String allowNegativeAccrualBalance)
void	setAllowScheduledLeave(String allowScheduledLeave)
void	setCountsAsRegularPay(String countsAsRegularPay)
void	setDefaultAmountofTime(Long defaultAmountofTime)
void	setDescription(String description)
void	setEarnCode(String earnCode)
void	setEligibleForAccrual(String eligibleForAccrual)
void	setFmla(String fmla)
void	setFractionalTimeAllowed(String fractionalTimeAllowed)
void	setHistory(boolean history)
void	setHrEarnCodeId(String hrEarnCodeId)
void	setId(String id)
void	setInflateFactor(BigDecimal inflateFactor)
void	setInflateMinHours(BigDecimal inflateMinHours)
void	setLeavePlan(String leavePlan)
void	setLeavePlanObj(LeavePlan leavePlanObj)
void	setOvtEarnCode(Boolean ovtEarnCode)
void	setRecordMethod(String recordMethod)
void	setRollupToEarnCode(String rollupToEarnCode)
void	setRollupToEarnCodeObj(EarnCode rollupToEarnCodeObj)
void	setRoundingOption(String roundingOption)
void	setUsageLimit(String usageLimit)
void	setWorkmansComp(String workmansComp)

Methods inherited from class org.kuali.kpme.core.bo.HrBusinessObject

getEffectiveDate, getEffectiveLocalDate, getRelativeEffectiveDate, getTimestamp, isActive, setActive, setEffectiveDate, setEffectiveLocalDate, setRelativeEffectiveDate, setTimestamp

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.kpme.core.api.bo.HrBusinessObjectContract

getEffectiveDate, getEffectiveLocalDate, getRelativeEffectiveDate, getTimestamp

Methods inherited from interface org.kuali.rice.krad.bo.PersistableBusinessObject

buildListOfDeletionAwareLists, getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

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

Field Detail

CACHE_NAME

public static final String CACHE_NAME

See Also:

Constant Field Values

CACHE_FLUSH

public static final com.google.common.collect.ImmutableList<String> CACHE_FLUSH

EQUAL_TO_FIELDS

public static final com.google.common.collect.ImmutableList<String> EQUAL_TO_FIELDS

Constructor Detail

EarnCode

public EarnCode()

Method Detail

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

setCountsAsRegularPay

public void setCountsAsRegularPay(String countsAsRegularPay)

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

setUsageLimit

public void setUsageLimit(String usageLimit)

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

setRecordMethod

public void setRecordMethod(String recordMethod)

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

setRollupToEarnCode

public void setRollupToEarnCode(String rollupToEarnCode)

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

setRollupToEarnCodeObj

public void setRollupToEarnCodeObj(EarnCode rollupToEarnCodeObj)

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

setLeavePlan

public void setLeavePlan(String leavePlan)

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

setAccrualBalanceAction

public void setAccrualBalanceAction(String accrualBalanceAction)

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

setFractionalTimeAllowed

public void setFractionalTimeAllowed(String fractionalTimeAllowed)

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

setRoundingOption

public void setRoundingOption(String roundingOption)

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

setEligibleForAccrual

public void setEligibleForAccrual(String eligibleForAccrual)

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

setAffectPay

public void setAffectPay(String affectPay)

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

setAllowScheduledLeave

public void setAllowScheduledLeave(String allowScheduledLeave)

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

setFmla

public void setFmla(String fmla)

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

setWorkmansComp

public void setWorkmansComp(String workmansComp)

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

setDefaultAmountofTime

public void setDefaultAmountofTime(Long defaultAmountofTime)

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

setAllowNegativeAccrualBalance

public void setAllowNegativeAccrualBalance(String allowNegativeAccrualBalance)

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

setEarnCode

public void setEarnCode(String 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

setDescription

public void setDescription(String description)

isHistory

public boolean isHistory()

Description copied from interface: EarnCodeContract

The history flag of an EarnCode

history flag of EarnCode

Specified by:

isHistory in interface EarnCodeContract

Returns:

history for EarnCode

setHistory

public void setHistory(boolean history)

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

setHrEarnCodeId

public void setHrEarnCodeId(String hrEarnCodeId)

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

setAccrualCategory

public void setAccrualCategory(String accrualCategory)

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

assingAccrualCategoryObj

public void assingAccrualCategoryObj()

setAccrualCategoryObj

public void setAccrualCategoryObj(AccrualCategory accrualCategoryObj)

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

setInflateMinHours

public void setInflateMinHours(BigDecimal inflateMinHours)

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

setInflateFactor

public void setInflateFactor(BigDecimal inflateFactor)

getOvtEarnCode

public Boolean getOvtEarnCode()

Description copied from interface: EarnCodeContract

Indicates this EarnCode may be used for overtime

ovtEarnCode flag of an EarnCode

Specified by:

getOvtEarnCode in interface EarnCodeContract

Returns:

Y for Yes, N for No

setOvtEarnCode

public void setOvtEarnCode(Boolean ovtEarnCode)

getEarnCodeType

public String getEarnCodeType()

This is used by the timeblock json object. The purpose of this function is to create a string based on the record_* fields which can be used to render hour / begin(end) time input box

Returns:

String fieldType

getUniqueKey

public String getUniqueKey()

Specified by:

getUniqueKey in class HrBusinessObject

getId

public String getId()

Description copied from interface: HrBusinessObjectContract

The unique id defined by the object, could be a combination of multiple fields

id of HrBusinessObject

Specified by:

getId in interface HrBusinessObjectContract

Specified by:

getId in class HrBusinessObject

Returns:

id of HrBusinessObject

setId

public void setId(String id)

Specified by:

setId in class HrBusinessObject

getEarnCodeKeyForDisplay

public String getEarnCodeKeyForDisplay()

getEarnCodeValueForDisplay

public String getEarnCodeValueForDisplay()

getLeavePlanObj

public LeavePlan getLeavePlanObj()

Description copied from interface: EarnCodeContract

The LeavePlan object associated with an EarnCode

leavePlanObj of an EarnCode

Specified by:

getLeavePlanObj in interface EarnCodeContract

Returns:

leavePlanObj for EarnCode

setLeavePlanObj

public void setLeavePlanObj(LeavePlan leavePlanObj)