org.kuali.kpme.tklm.time.rules.overtime.weekly
Class WeeklyOvertimeRule

java.lang.Object
  org.kuali.rice.krad.bo.BusinessObjectBase
      org.kuali.rice.krad.bo.PersistableBusinessObjectBase
          org.kuali.kpme.core.bo.HrBusinessObject
              org.kuali.kpme.tklm.time.rules.TkRule
                  org.kuali.kpme.tklm.time.rules.overtime.weekly.WeeklyOvertimeRule

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, HrBusinessObjectContract, WeeklyOvertimeRuleContract, TkRuleContract, 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 WeeklyOvertimeRule
extends TkRule
implements WeeklyOvertimeRuleContract

See Also:

Serialized Form

Field Summary

static String

CACHE_NAME

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

extension, versionNumber

Constructor Summary

WeeklyOvertimeRule()

Method Summary

String	getConvertFromEarnGroup() The EarnGroup name defined to represent the earn codes to be converted to overtime
EarnCodeGroup	getConvertFromEarnGroupObj() The EarnCodeGroup object defined to represent the earn codes to be converted to overtime
String	getConvertToEarnCode() The default EarnCode name which other earnings will be converted to
EarnCode	getConvertToEarnCodeObj() The default EarnCode object which other earnings will be converted to
String	getId() The unique id defined by the object, could be a combination of multiple fields
BigDecimal	getMaxHours() The maximum hours in an FLSA period for overtime calculation
String	getMaxHoursEarnGroup() The EarnGroup name defined to represent the earn codes which count towards the calculation of overtime
EarnCodeGroup	getMaxHoursEarnGroupObj() The EarnCodeGroup object defined to represent the earn codes which count towards the calculation of overtime
Boolean	getOvtEarnCode() Indicates this EarnCode may be used for overtime
BigDecimal	getStep() The definition of multiple steps
Long	getTkWeeklyOvertimeRuleGroupId() The WeeklyOvertimeRuleGroup id associated with the WeeklyOvertimeRule
String	getTkWeeklyOvertimeRuleId() The primary key of a WeeklyOvertimeRule entry saved in a database
String	getUniqueKey()
String	getUserPrincipalId() The userPrincipalId associated with the WeeklyOvertimeRule
void	setConvertFromEarnGroup(String convertFromEarnGroup)
void	setConvertFromEarnGroupObj(EarnCodeGroup convertFromEarnGroupObj)
void	setConvertToEarnCode(String convertToEarnCode)
void	setConvertToEarnCodeObj(EarnCode convertToEarnCodeObj)
void	setId(String id)
void	setMaxHours(BigDecimal maxHours)
void	setMaxHoursEarnGroup(String maxHoursEarnGroup)
void	setMaxHoursEarnGroupObj(EarnCodeGroup maxHoursEarnGroupObj)
void	setOvtEarnCode(Boolean ovtEarnCode)
void	setStep(BigDecimal step)
void	setTkWeeklyOvertimeRuleGroupId(Long tkWeeklyOvertimeRuleGroupId)
void	setTkWeeklyOvertimeRuleId(String tkWeeklyOvertimeRuleId)
void	setUserPrincipalId(String userPrincipalId)

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

Constructor Detail

WeeklyOvertimeRule

public WeeklyOvertimeRule()

Method Detail

getTkWeeklyOvertimeRuleId

public String getTkWeeklyOvertimeRuleId()

Description copied from interface: WeeklyOvertimeRuleContract

The primary key of a WeeklyOvertimeRule entry saved in a database

tkWeeklyOvertimeRuleId of a WeeklyOvertimeRule

Specified by:

getTkWeeklyOvertimeRuleId in interface WeeklyOvertimeRuleContract

Returns:

tkWeeklyOvertimeRuleId for WeeklyOvertimeRule

setTkWeeklyOvertimeRuleId

public void setTkWeeklyOvertimeRuleId(String tkWeeklyOvertimeRuleId)

getMaxHoursEarnGroup

public String getMaxHoursEarnGroup()

Description copied from interface: WeeklyOvertimeRuleContract

The EarnGroup name defined to represent the earn codes which count towards the calculation of overtime

maxHoursEarnGroup of a WeeklyOvertimeRule

Specified by:

getMaxHoursEarnGroup in interface WeeklyOvertimeRuleContract

Returns:

maxHoursEarnGroup for WeeklyOvertimeRule

setMaxHoursEarnGroup

public void setMaxHoursEarnGroup(String maxHoursEarnGroup)

getConvertFromEarnGroup

public String getConvertFromEarnGroup()

Description copied from interface: WeeklyOvertimeRuleContract

The EarnGroup name defined to represent the earn codes to be converted to overtime

If there is only one step in overtime calculation, this will be the same earn group as max hours. If there are multiple steps, this will be an earn group which is a subset of the max hours earn group

Specified by:

getConvertFromEarnGroup in interface WeeklyOvertimeRuleContract

Returns:

convertFromEarnGroup for WeeklyOvertimeRule

setConvertFromEarnGroup

public void setConvertFromEarnGroup(String convertFromEarnGroup)

getConvertToEarnCode

public String getConvertToEarnCode()

Description copied from interface: WeeklyOvertimeRuleContract

The default EarnCode name which other earnings will be converted to

Only earn codes that are designated as an Overtime Earn Code can be used. This earn code is used for overtime hours unless the Work Area for the Assignment has a designated Default Overtime Earn Code.

Specified by:

getConvertToEarnCode in interface WeeklyOvertimeRuleContract

Returns:

convertToEarnCode for WeeklyOvertimeRule

setConvertToEarnCode

public void setConvertToEarnCode(String convertToEarnCode)

getStep

public BigDecimal getStep()

Description copied from interface: WeeklyOvertimeRuleContract

The definition of multiple steps

This enables the definition of multiple steps in the hours conversion for overtime

Specified by:

getStep in interface WeeklyOvertimeRuleContract

Returns:

step for WeeklyOvertimeRule

setStep

public void setStep(BigDecimal step)

getMaxHours

public BigDecimal getMaxHours()

Description copied from interface: WeeklyOvertimeRuleContract

The maximum hours in an FLSA period for overtime calculation

maxHours of a WeeklyOvertimeRule

Specified by:

getMaxHours in interface WeeklyOvertimeRuleContract

Returns:

maxHours for WeeklyOvertimeRule

setMaxHours

public void setMaxHours(BigDecimal maxHours)

getUserPrincipalId

public String getUserPrincipalId()

Description copied from interface: WeeklyOvertimeRuleContract

The userPrincipalId associated with the WeeklyOvertimeRule

userPrincipalId of a WeeklyOvertimeRule

Specified by:

getUserPrincipalId in interface WeeklyOvertimeRuleContract

Returns:

userPrincipalId for WeeklyOvertimeRule

setUserPrincipalId

public void setUserPrincipalId(String userPrincipalId)

getOvtEarnCode

public Boolean getOvtEarnCode()

Description copied from interface: WeeklyOvertimeRuleContract

Indicates this EarnCode may be used for overtime

ovtEarnCode falg of a WeeklyOvertimeRule

Specified by:

getOvtEarnCode in interface WeeklyOvertimeRuleContract

Returns:

Y if used for over time, N if not

setOvtEarnCode

public void setOvtEarnCode(Boolean ovtEarnCode)

getMaxHoursEarnGroupObj

public EarnCodeGroup getMaxHoursEarnGroupObj()

Description copied from interface: WeeklyOvertimeRuleContract

The EarnCodeGroup object defined to represent the earn codes which count towards the calculation of overtime

maxHoursEarnGroupObj of a WeeklyOvertimeRule

Specified by:

getMaxHoursEarnGroupObj in interface WeeklyOvertimeRuleContract

Returns:

maxHoursEarnGroupObj for WeeklyOvertimeRule

setMaxHoursEarnGroupObj

public void setMaxHoursEarnGroupObj(EarnCodeGroup maxHoursEarnGroupObj)

getConvertFromEarnGroupObj

public EarnCodeGroup getConvertFromEarnGroupObj()

Description copied from interface: WeeklyOvertimeRuleContract

The EarnCodeGroup object defined to represent the earn codes to be converted to overtime

convertFromEarnGroupObj of a WeeklyOvertimeRule

Specified by:

getConvertFromEarnGroupObj in interface WeeklyOvertimeRuleContract

Returns:

convertFromEarnGroupObj for WeeklyOvertimeRule

setConvertFromEarnGroupObj

public void setConvertFromEarnGroupObj(EarnCodeGroup convertFromEarnGroupObj)

getConvertToEarnCodeObj

public EarnCode getConvertToEarnCodeObj()

Description copied from interface: WeeklyOvertimeRuleContract

The default EarnCode object which other earnings will be converted to

convertToEarnCodeObj of a WeeklyOvertimeRule

Specified by:

getConvertToEarnCodeObj in interface WeeklyOvertimeRuleContract

Returns:

convertToEarnCodeObj for WeeklyOvertimeRule

setConvertToEarnCodeObj

public void setConvertToEarnCodeObj(EarnCode convertToEarnCodeObj)

getTkWeeklyOvertimeRuleGroupId

public Long getTkWeeklyOvertimeRuleGroupId()

Description copied from interface: WeeklyOvertimeRuleContract

The WeeklyOvertimeRuleGroup id associated with the WeeklyOvertimeRule

tkWeeklyOvertimeRuleGroupId of a WeeklyOvertimeRule

Specified by:

getTkWeeklyOvertimeRuleGroupId in interface WeeklyOvertimeRuleContract

Returns:

tkWeeklyOvertimeRuleGroupId for WeeklyOvertimeRule

setTkWeeklyOvertimeRuleGroupId

public void setTkWeeklyOvertimeRuleGroupId(Long tkWeeklyOvertimeRuleGroupId)

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