org.kuali.kpme.tklm.api.time.rules.shiftdifferential
Interface ShiftDifferentialRuleContract

All Superinterfaces:

org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.core.api.mo.common.GloballyUnique, HrBusinessObjectContract, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.PersistableBusinessObject, Serializable, TkRuleContract, org.kuali.rice.core.api.mo.common.Versioned

All Known Implementing Classes:

ShiftDifferentialRule

public interface ShiftDifferentialRuleContract
extends TkRuleContract

ShiftDifferentialRuleContract interface

Method Summary

Time	getBeginTime() The beginning time of the eligible shift
String	getEarnCode() The earn code associated with the ShiftDifferentialRule
EarnCodeContract	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
EarnCodeGroupContract	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	getLocation() The location associated with the ShiftDifferentialRule
LocationContract	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
CalendarContract	getPayCalendar() The Calendar object associated with the ShiftDifferentialRule
String	getPayGrade() The pay grade associated with the ShiftDifferentialRule
PayGradeContract	getPayGradeObj() The PayGrade object associated with the ShiftDifferentialRule
String	getPyCalendarGroup() Pay Calendar record that defines the FLSA period
SalaryGroupContract	getSalaryGroupObj() The SalaryGroup object associated with the ShiftDifferentialRule
String	getTkShiftDiffRuleId() The primary key of a ShiftDifferentialRule entry saved in a database
String	getUserPrincipalId() The user that sets up the ShiftDifferentialRule
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.

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

getEffectiveDate, getEffectiveLocalDate, getId, 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

Method Detail

getTkShiftDiffRuleId

String getTkShiftDiffRuleId()

The primary key of a ShiftDifferentialRule entry saved in a database

tkShiftDiffRuleId of a ShiftDifferentialRule

Returns:

tkShiftDiffRuleId for ShiftDifferentialRule

getLocation

String getLocation()

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.

Returns:

location for ShiftDifferentialRule

getPayGrade

String getPayGrade()

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.

Returns:

payGrade for ShiftDifferentialRule

getEarnCode

String getEarnCode()

The earn code associated with the ShiftDifferentialRule

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

Returns:

earnCode for ShiftDifferentialRule

getMinHours

BigDecimal getMinHours()

The minimum hours associated with the ShiftDifferentialRule

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

Returns:

minHours for ShiftDifferentialRule

getMaxGap

BigDecimal getMaxGap()

The max gap associated with the ShiftDifferentialRule

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

Returns:

maxGap for ShiftDifferentialRule

getUserPrincipalId

String getUserPrincipalId()

The user that sets up the ShiftDifferentialRule

userPrincipalId of a ShiftDifferentialRule

Returns:

userPrincipalId for ShiftDifferentialRule

getHrSalGroup

String getHrSalGroup()

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.

Returns:

hrSalGroup for ShiftDifferentialRule

getPyCalendarGroup

String getPyCalendarGroup()

Pay Calendar record that defines the FLSA period

pyCalendarGroup of a ShiftDifferentialRule

Returns:

pyCalendarGroup for ShiftDifferentialRule

getBeginTime

Time getBeginTime()

The beginning time of the eligible shift

beginTime of a ShiftDifferentialRule

Returns:

beginTime for ShiftDifferentialRule

getEndTime

Time getEndTime()

The end time of the eligible shift.

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

Returns:

endTime for ShiftDifferentialRule

getFromEarnGroup

String getFromEarnGroup()

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.

Returns:

fromEarnGroup for ShiftDifferentialRule

isSunday

boolean isSunday()

The flag that indicates if Sunday is eligible for shift differential

sunday flag of a ShiftDifferentialRule

Returns:

Y if Sunday is eligible, N if not

isMonday

boolean isMonday()

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

monday flag of a ShiftDifferentialRule

Returns:

Y if Monday is eligible, N if not

isTuesday

boolean isTuesday()

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

tuesday flag of a ShiftDifferentialRule

Returns:

Y if Tuesday is eligible, N if not

isWednesday

boolean isWednesday()

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

wednesday flag of a ShiftDifferentialRule

Returns:

Y if Wednesday is eligible, N if not

isThursday

boolean isThursday()

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

thursday flag of a ShiftDifferentialRule

Returns:

Y if Thursday is eligible, N if not

isFriday

boolean isFriday()

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

friday flag of a ShiftDifferentialRule

Returns:

Y if Friday is eligible, N if not

isSaturday

boolean isSaturday()

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

saturday flag of a ShiftDifferentialRule

Returns:

Y if Saturday is eligible, N if not

getEarnCodeObj

EarnCodeContract getEarnCodeObj()

The EarnCode object associated with the ShiftDifferentialRule

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

Returns:

earnCodeObj for ShiftDifferentialRule

getSalaryGroupObj

SalaryGroupContract getSalaryGroupObj()

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.

Returns:

salaryGroupObj for ShiftDifferentialRule

getFromEarnGroupObj

EarnCodeGroupContract getFromEarnGroupObj()

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.

Returns:

fromEarnGroupObj for ShiftDifferentialRule

getPayCalendar

CalendarContract getPayCalendar()

The Calendar object associated with the ShiftDifferentialRule

payCalendar for a ShiftDifferentialRule

Returns:

payCalendar for ShiftDifferentialRule

getLocationObj

LocationContract getLocationObj()

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.

Returns:

locationObj for a ShiftDifferentialRule

getPayGradeObj

PayGradeContract getPayGradeObj()

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.

Returns:

payGradeObj for a ShiftDifferentialRule

getHrSalGroupId

String getHrSalGroupId()

The id of the SalaryGroup object associated with the ShiftDifferentialRule

hrSalGroupId for a ShiftDifferentialRule

Returns:

hrSalGroupId for ShiftDifferentialRule

getHrLocationId

String getHrLocationId()

The id of the Location object associated with the ShiftDifferentialRule

hrLocationId for a ShiftDifferentialRule

Returns:

hrLocationId for ShiftDifferentialRule

getHrPayGradeId

String getHrPayGradeId()

The id of the PayGrade object associated with the ShiftDifferentialRule

hrPayGradeId for a ShiftDifferentialRule

Returns:

hrPayGradeId for ShiftDifferentialRule

isHistory

boolean isHistory()

The history flag of the ShiftDifferentialRule

history flag of a ShiftDifferentialRule

Returns:

Y if on, N if not