org.kuali.kpme.tklm.time.rules.shiftdifferential

Class ShiftDifferentialRule

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.shiftdifferential.ShiftDifferentialRule

All Implemented Interfaces:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
ShiftDifferentialRule()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Time	getBeginTime() The beginning time of the eligible shift
String	getEarnCode() The earn code associated with the ShiftDifferentialRule
EarnCode	getEarnCodeObj() The EarnCode object associated with the ShiftDifferentialRule
Time	getEndTime() The end time of the eligible shift.
String	getFromEarnGroup() The earn group associated with the ShiftDifferentialRule
EarnCodeGroup	getFromEarnGroupObj() The EarnCodeGroup object associated with the ShiftDifferentialRule
String	getHrLocationId() The id of the Location object associated with the ShiftDifferentialRule
String	getHrPayGradeId() The id of the PayGrade object associated with the ShiftDifferentialRule
String	getHrSalGroup() The salary group associated with the ShiftDifferentialRule
String	getHrSalGroupId() The id of the SalaryGroup object associated with the ShiftDifferentialRule
String	getId() The unique id defined by the object, could be a combination of multiple fields
String	getLocation() The location associated with the ShiftDifferentialRule
Location	getLocationObj() The Location object associated with the ShiftDifferentialRule
BigDecimal	getMaxGap() The max gap associated with the ShiftDifferentialRule
BigDecimal	getMinHours() The minimum hours associated with the ShiftDifferentialRule
Calendar	getPayCalendar() The Calendar object associated with the ShiftDifferentialRule
String	getPayGrade() The pay grade associated with the ShiftDifferentialRule
PayGrade	getPayGradeObj() The PayGrade object associated with the ShiftDifferentialRule
String	getPyCalendarGroup() Pay Calendar record that defines the FLSA period
SalaryGroup	getSalaryGroupObj() The SalaryGroup object associated with the ShiftDifferentialRule
String	getTkShiftDiffRuleId() The primary key of a ShiftDifferentialRule entry saved in a database
String	getUniqueKey()
String	getUserPrincipalId() The user that sets up the ShiftDifferentialRule
int	hashCode()
boolean	isFriday() The flag that indicates if Friday is eligible for shift differential.
boolean	isHistory() The history flag of the ShiftDifferentialRule
boolean	isMonday() The flag that indicates if Monday is eligible for shift differential.
boolean	isSaturday() The flag that indicates if Saturday is eligible for shift differential.
boolean	isSunday() The flag that indicates if Sunday is eligible for shift differential
boolean	isThursday() The flag that indicates if Thursday is eligible for shift differential.
boolean	isTuesday() The flag that indicates if Tuesday is eligible for shift differential.
boolean	isWednesday() The flag that indicates if Wednesday is eligible for shift differential.
void	setBeginTime(Time beginTime)
void	setEarnCode(String earnCode)
void	setEarnCodeObj(EarnCode earnCodeObj)
void	setEndTime(Time endTime)
void	setFriday(boolean friday)
void	setFromEarnGroup(String fromEarnGroup)
void	setFromEarnGroupObj(EarnCodeGroup fromEarnGroupObj)
void	setHistory(boolean history)
void	setHrLocationId(String hrLocationId)
void	setHrPayGradeId(String hrPayGradeId)
void	setHrSalGroup(String hrSalGroup)
void	setHrSalGroupId(String hrSalGroupId)
void	setId(String id)
void	setLocation(String location)
void	setLocationObj(Location locationObj)
void	setMaxGap(BigDecimal maxGap)
void	setMinHours(BigDecimal minHours)
void	setMonday(boolean monday)
void	setPayCalendar(Calendar payCalendar)
void	setPayGrade(String payGrade)
void	setPayGradeObj(PayGrade payGradeObj)
void	setPyCalendarGroup(String pyCalendarGroup)
void	setSalaryGroupObj(SalaryGroup salaryGroupObj)
void	setSaturday(boolean saturday)
void	setSunday(boolean sunday)
void	setThursday(boolean thursday)
void	setTkShiftDiffRuleId(String tkShiftDiffRuleId)
void	setTuesday(boolean tuesday)
void	setUserPrincipalId(String userPrincipalId)
void	setWednesday(boolean wednesday)

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, finalize, getClass, 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

EQUAL_TO_FIELDS

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

Constructor Detail

ShiftDifferentialRule

public ShiftDifferentialRule()

Method Detail

getTkShiftDiffRuleId

public String getTkShiftDiffRuleId()

Description copied from interface: ShiftDifferentialRuleContract

The primary key of a ShiftDifferentialRule entry saved in a database

tkShiftDiffRuleId of a ShiftDifferentialRule

Specified by:

getTkShiftDiffRuleId in interface ShiftDifferentialRuleContract

Returns:

tkShiftDiffRuleId for ShiftDifferentialRule

setTkShiftDiffRuleId

public void setTkShiftDiffRuleId(String tkShiftDiffRuleId)

getLocation

public String getLocation()

Description copied from interface: ShiftDifferentialRuleContract

The location associated with the ShiftDifferentialRule

If a location is defined, only entries associated with a job in this location will be subject to the shift rule.

Specified by:

getLocation in interface ShiftDifferentialRuleContract

Returns:

location for ShiftDifferentialRule

setLocation

public void setLocation(String location)

getPayGrade

public String getPayGrade()

Description copied from interface: ShiftDifferentialRuleContract

The pay grade associated with the ShiftDifferentialRule

If a pay grade is defined, only entries associated with a job in this pay grade will be subject to the shift rule.

Specified by:

getPayGrade in interface ShiftDifferentialRuleContract

Returns:

payGrade for ShiftDifferentialRule

setPayGrade

public void setPayGrade(String payGrade)

getEarnCode

public String getEarnCode()

Description copied from interface: ShiftDifferentialRuleContract

The earn code associated with the ShiftDifferentialRule

The earn code that will be applied to the eligible shift and result in additional earnings.

Specified by:

getEarnCode in interface ShiftDifferentialRuleContract

Returns:

earnCode for ShiftDifferentialRule

setEarnCode

public void setEarnCode(String earnCode)

getMinHours

public BigDecimal getMinHours()

Description copied from interface: ShiftDifferentialRuleContract

The minimum hours associated with the ShiftDifferentialRule

The minimum number of hours a shift must be in order to qualify for shift differential.

Specified by:

getMinHours in interface ShiftDifferentialRuleContract

Returns:

minHours for ShiftDifferentialRule

setMinHours

public void setMinHours(BigDecimal minHours)

getMaxGap

public BigDecimal getMaxGap()

Description copied from interface: ShiftDifferentialRuleContract

The max gap associated with the ShiftDifferentialRule

The maximum number of minutes which can separate time blocks, and still qualify as an eligible shift.

Specified by:

getMaxGap in interface ShiftDifferentialRuleContract

Returns:

The maximum gap, in hours.

setMaxGap

public void setMaxGap(BigDecimal maxGap)

Parameters:

maxGap - The number of hours that can be between one time block and another for the rule to consider it part of the same shift.

getUserPrincipalId

public String getUserPrincipalId()

Description copied from interface: ShiftDifferentialRuleContract

The user that sets up the ShiftDifferentialRule

userPrincipalId of a ShiftDifferentialRule

Specified by:

getUserPrincipalId in interface ShiftDifferentialRuleContract

Returns:

userPrincipalId for ShiftDifferentialRule

setUserPrincipalId

public void setUserPrincipalId(String userPrincipalId)

getHrSalGroup

public String getHrSalGroup()

Description copied from interface: ShiftDifferentialRuleContract

The salary group associated with the ShiftDifferentialRule

If a salary group is defined, only entries associated with a job in this salary group will be subject to the shift rule.

Specified by:

getHrSalGroup in interface ShiftDifferentialRuleContract

Returns:

hrSalGroup for ShiftDifferentialRule

setHrSalGroup

public void setHrSalGroup(String hrSalGroup)

getPyCalendarGroup

public String getPyCalendarGroup()

Description copied from interface: ShiftDifferentialRuleContract

Pay Calendar record that defines the FLSA period

pyCalendarGroup of a ShiftDifferentialRule

Specified by:

getPyCalendarGroup in interface ShiftDifferentialRuleContract

Returns:

pyCalendarGroup for ShiftDifferentialRule

setPyCalendarGroup

public void setPyCalendarGroup(String pyCalendarGroup)

getBeginTime

public Time getBeginTime()

Description copied from interface: ShiftDifferentialRuleContract

The beginning time of the eligible shift

beginTime of a ShiftDifferentialRule

Specified by:

getBeginTime in interface ShiftDifferentialRuleContract

Returns:

beginTime for ShiftDifferentialRule

setBeginTime

public void setBeginTime(Time beginTime)

getEndTime

public Time getEndTime()

Description copied from interface: ShiftDifferentialRuleContract

The end time of the eligible shift.

This could be on the following day if the eligible shift is overnight.

Specified by:

getEndTime in interface ShiftDifferentialRuleContract

Returns:

endTime for ShiftDifferentialRule

setEndTime

public void setEndTime(Time endTime)

getFromEarnGroup

public String getFromEarnGroup()

Description copied from interface: ShiftDifferentialRuleContract

The earn group associated with the ShiftDifferentialRule

The earn group defined (using the Earn Group maint doc) to represent the earn codes to be converted to Shift Differential Earn Code.

Specified by:

getFromEarnGroup in interface ShiftDifferentialRuleContract

Returns:

fromEarnGroup for ShiftDifferentialRule

setFromEarnGroup

public void setFromEarnGroup(String fromEarnGroup)

isSunday

public boolean isSunday()

Description copied from interface: ShiftDifferentialRuleContract

The flag that indicates if Sunday is eligible for shift differential

sunday flag of a ShiftDifferentialRule

Specified by:

isSunday in interface ShiftDifferentialRuleContract

Returns:

Y if Sunday is eligible, N if not

setSunday

public void setSunday(boolean sunday)

isMonday

public boolean isMonday()

Description copied from interface: ShiftDifferentialRuleContract

The flag that indicates if Monday is eligible for shift differential.

monday flag of a ShiftDifferentialRule

Specified by:

isMonday in interface ShiftDifferentialRuleContract

Returns:

Y if Monday is eligible, N if not

setMonday

public void setMonday(boolean monday)

isTuesday

public boolean isTuesday()

Description copied from interface: ShiftDifferentialRuleContract

The flag that indicates if Tuesday is eligible for shift differential.

tuesday flag of a ShiftDifferentialRule

Specified by:

isTuesday in interface ShiftDifferentialRuleContract

Returns:

Y if Tuesday is eligible, N if not

setTuesday

public void setTuesday(boolean tuesday)

isWednesday

public boolean isWednesday()

Description copied from interface: ShiftDifferentialRuleContract

The flag that indicates if Wednesday is eligible for shift differential.

wednesday flag of a ShiftDifferentialRule

Specified by:

isWednesday in interface ShiftDifferentialRuleContract

Returns:

Y if Wednesday is eligible, N if not

setWednesday

public void setWednesday(boolean wednesday)

isThursday

public boolean isThursday()

Description copied from interface: ShiftDifferentialRuleContract

The flag that indicates if Thursday is eligible for shift differential.

thursday flag of a ShiftDifferentialRule

Specified by:

isThursday in interface ShiftDifferentialRuleContract

Returns:

Y if Thursday is eligible, N if not

setThursday

public void setThursday(boolean thursday)

isFriday

public boolean isFriday()

Description copied from interface: ShiftDifferentialRuleContract

The flag that indicates if Friday is eligible for shift differential.

friday flag of a ShiftDifferentialRule

Specified by:

isFriday in interface ShiftDifferentialRuleContract

Returns:

Y if Friday is eligible, N if not

setFriday

public void setFriday(boolean friday)

isSaturday

public boolean isSaturday()

Description copied from interface: ShiftDifferentialRuleContract

The flag that indicates if Saturday is eligible for shift differential.

saturday flag of a ShiftDifferentialRule

Specified by:

isSaturday in interface ShiftDifferentialRuleContract

Returns:

Y if Saturday is eligible, N if not

setSaturday

public void setSaturday(boolean saturday)

getEarnCodeObj

public EarnCode getEarnCodeObj()

Description copied from interface: ShiftDifferentialRuleContract

The EarnCode object associated with the ShiftDifferentialRule

The earn code that will be applied to the eligible shift and result in additional earnings.

Specified by:

getEarnCodeObj in interface ShiftDifferentialRuleContract

Returns:

earnCodeObj for ShiftDifferentialRule

setEarnCodeObj

public void setEarnCodeObj(EarnCode earnCodeObj)

getSalaryGroupObj

public SalaryGroup getSalaryGroupObj()

Description copied from interface: ShiftDifferentialRuleContract

The SalaryGroup object associated with the ShiftDifferentialRule

If a salary group is defined, only entries associated with a job in this salary group will be subject to the shift rule.

Specified by:

getSalaryGroupObj in interface ShiftDifferentialRuleContract

Returns:

salaryGroupObj for ShiftDifferentialRule

setSalaryGroupObj

public void setSalaryGroupObj(SalaryGroup salaryGroupObj)

getFromEarnGroupObj

public EarnCodeGroup getFromEarnGroupObj()

Description copied from interface: ShiftDifferentialRuleContract

The EarnCodeGroup object associated with the ShiftDifferentialRule

The earn group defined (using the Earn Group maint doc) to represent the earn codes to be converted to Shift Differential Earn Code.

Specified by:

getFromEarnGroupObj in interface ShiftDifferentialRuleContract

Returns:

fromEarnGroupObj for ShiftDifferentialRule

setFromEarnGroupObj

public void setFromEarnGroupObj(EarnCodeGroup fromEarnGroupObj)

getPayCalendar

public Calendar getPayCalendar()

Description copied from interface: ShiftDifferentialRuleContract

The Calendar object associated with the ShiftDifferentialRule

payCalendar for a ShiftDifferentialRule

Specified by:

getPayCalendar in interface ShiftDifferentialRuleContract

Returns:

payCalendar for ShiftDifferentialRule

setPayCalendar

public void setPayCalendar(Calendar payCalendar)

getLocationObj

public Location getLocationObj()

Description copied from interface: ShiftDifferentialRuleContract

The Location object associated with the ShiftDifferentialRule

If a location is defined, only entries associated with a job in this location will be subject to the shift rule.

Specified by:

getLocationObj in interface ShiftDifferentialRuleContract

Returns:

locationObj for a ShiftDifferentialRule

setLocationObj

public void setLocationObj(Location locationObj)

getPayGradeObj

public PayGrade getPayGradeObj()

Description copied from interface: ShiftDifferentialRuleContract

The PayGrade object associated with the ShiftDifferentialRule

If a pay grade is defined, only entries associated with a job in this pay grade will be subject to the shift rule.

Specified by:

getPayGradeObj in interface ShiftDifferentialRuleContract

Returns:

payGradeObj for a ShiftDifferentialRule

setPayGradeObj

public void setPayGradeObj(PayGrade payGradeObj)

getHrSalGroupId

public String getHrSalGroupId()

Description copied from interface: ShiftDifferentialRuleContract

The id of the SalaryGroup object associated with the ShiftDifferentialRule

hrSalGroupId for a ShiftDifferentialRule

Specified by:

getHrSalGroupId in interface ShiftDifferentialRuleContract

Returns:

hrSalGroupId for ShiftDifferentialRule

setHrSalGroupId

public void setHrSalGroupId(String hrSalGroupId)

getHrLocationId

public String getHrLocationId()

Description copied from interface: ShiftDifferentialRuleContract

The id of the Location object associated with the ShiftDifferentialRule

hrLocationId for a ShiftDifferentialRule

Specified by:

getHrLocationId in interface ShiftDifferentialRuleContract

Returns:

hrLocationId for ShiftDifferentialRule

setHrLocationId

public void setHrLocationId(String hrLocationId)

getHrPayGradeId

public String getHrPayGradeId()

Description copied from interface: ShiftDifferentialRuleContract

The id of the PayGrade object associated with the ShiftDifferentialRule

hrPayGradeId for a ShiftDifferentialRule

Specified by:

getHrPayGradeId in interface ShiftDifferentialRuleContract

Returns:

hrPayGradeId for ShiftDifferentialRule

setHrPayGradeId

public void setHrPayGradeId(String hrPayGradeId)

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

isHistory

public boolean isHistory()

Description copied from interface: ShiftDifferentialRuleContract

The history flag of the ShiftDifferentialRule

history flag of a ShiftDifferentialRule

Specified by:

isHistory in interface ShiftDifferentialRuleContract

Returns:

Y if on, N if not

setHistory

public void setHistory(boolean history)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object