org.kuali.kpme.core.api.leaveplan

Class LeavePlan

java.lang.Object

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

org.kuali.kpme.core.api.leaveplan.LeavePlan

All Implemented Interfaces:

Serializable, LeavePlanContract, 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 LeavePlan
extends org.kuali.rice.core.api.mo.AbstractDataTransferObject
implements LeavePlanContract

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from interface org.kuali.kpme.core.api.leaveplan.LeavePlanContract

CACHE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
String	getBatchPriorYearCarryOverStartDate() The date batch job should run to create a carry over leave block for each accrual category balance from the prior year under a LeavePlan
org.joda.time.LocalTime	getBatchPriorYearCarryOverStartLocalTime() The Time batch job should run to create a carry over leave block for each accrual category balance from the prior year under a LeavePlan
String	getCalendarYearStart() The Month and Day (MM/DD) of the start of the year for a LeavePlan
String	getCalendarYearStartDayOfMonth()
String	getCalendarYearStartMonth()
org.joda.time.DateTime	getCreateTime() The timestamp of when this HrBusinessObject was last created/updated
String	getDescr() The description of a LeavePlan
org.joda.time.LocalDate	getEffectiveLocalDate() The localDate format of the effective date of the HrBusinessObject
String	getId()
String	getLeavePlan() The name of a LeavePlan
String	getLmLeavePlanId() The Primary Key of a LeavePlan entry saved in a database
String	getObjectId()
String	getPlanningMonths() The Number of months to build accruals for for a LeavePlan
String	getUserPrincipalId() The userPrincipalId of when this HrBusinessObject was last created/updated
Long	getVersionNumber()
boolean	isActive()

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

getBatchPriorYearCarryOverStartLocalTime

public org.joda.time.LocalTime getBatchPriorYearCarryOverStartLocalTime()

Description copied from interface: LeavePlanContract

The Time batch job should run to create a carry over leave block for each accrual category balance from the prior year under a LeavePlan

batchPriorYearCarryOverStartTime of a LeavePlan

Specified by:

getBatchPriorYearCarryOverStartLocalTime in interface LeavePlanContract

Returns:

batchPriorYearCarryOverStartTime for LeavePlan

getPlanningMonths

public String getPlanningMonths()

Description copied from interface: LeavePlanContract

The Number of months to build accruals for for a LeavePlan

planningMonths of a LeavePlan

Specified by:

getPlanningMonths in interface LeavePlanContract

Returns:

planningMonths for LeavePlan

getLmLeavePlanId

public String getLmLeavePlanId()

Description copied from interface: LeavePlanContract

The Primary Key of a LeavePlan entry saved in a database

lmLeavePlanId of an LeavePlan

Specified by:

getLmLeavePlanId in interface LeavePlanContract

Returns:

lmLeavePlanId for LeavePlan

getLeavePlan

public String getLeavePlan()

Description copied from interface: LeavePlanContract

The name of a LeavePlan

leavePlan field of a LeavePlan

Specified by:

getLeavePlan in interface LeavePlanContract

Returns:

leavePlan for LeavePlan

getDescr

public String getDescr()

Description copied from interface: LeavePlanContract

The description of a LeavePlan

description of a LeavePlan

Specified by:

getDescr in interface LeavePlanContract

Returns:

description for LeavePlan

getCalendarYearStart

public String getCalendarYearStart()

Description copied from interface: LeavePlanContract

The Month and Day (MM/DD) of the start of the year for a LeavePlan

calendarYearStart of a LeavePlan

Specified by:

getCalendarYearStart in interface LeavePlanContract

Returns:

calendarYearStart for LeavePlan

getBatchPriorYearCarryOverStartDate

public String getBatchPriorYearCarryOverStartDate()

Description copied from interface: LeavePlanContract

The date batch job should run to create a carry over leave block for each accrual category balance from the prior year under a LeavePlan

batchPriorYearCarryOverStartDate of a LeavePlan

Specified by:

getBatchPriorYearCarryOverStartDate in interface LeavePlanContract

Returns:

batchPriorYearCarryOverStartDate for LeavePlan

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

getCalendarYearStartMonth

public String getCalendarYearStartMonth()

getCalendarYearStartDayOfMonth

public String getCalendarYearStartDayOfMonth()