org.kuali.kpme.core.api.salarygroup

Class SalaryGroup.Builder

java.lang.Object

org.kuali.kpme.core.api.salarygroup.SalaryGroup.Builder

All Implemented Interfaces:

Serializable, CreateTime, Effective, KeyedSetData, KpmeDataTransferObject, KpmeEffectiveDataTransferObject, KpmeEffectiveKeyedSetDataTransferObject, UserModified, SalaryGroupContract, 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.ModelBuilder

Enclosing class:

SalaryGroup

public static final class SalaryGroup.Builder
extends Object
implements Serializable, SalaryGroupContract, org.kuali.rice.core.api.mo.ModelBuilder

A builder which can be used to construct SalaryGroup instances. Enforces the constraints of the SalaryGroupContract.

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.kuali.kpme.core.api.salarygroup.SalaryGroupContract

CACHE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
SalaryGroup	build()
static SalaryGroup.Builder	create(SalaryGroupContract contract)
static SalaryGroup.Builder	create(String hrSalaryGroup)
String	getBenefitsEligible() Flag indicating if the SalaryGroup is eligible for benefits
org.joda.time.DateTime	getCreateTime() The timestamp of when this HrBusinessObject was last created/updated
String	getDescr() Description of the salary group
Set<EffectiveKey.Builder>	getEffectiveKeySet() The set of EffectiveKeyContract objects that hold the aggregate "white-list" of groupkeys for this PostionReportGroupContract object.
org.joda.time.LocalDate	getEffectiveLocalDate() The localDate format of the effective date of the HrBusinessObject
Set<String>	getGroupKeyCodeSet()
Set<HrGroupKey.Builder>	getGroupKeySet()
String	getHrSalGroup() Text field used to identify the salary group
String	getHrSalGroupId() The Primary Key of a SalaryGroup entry saved in a database
String	getId()
String	getInstitution() The name of the institution the salary group is associated with.
String	getLeaveEligible() Flag indicating if the SalaryGroup is eligible for leave benefits
String	getLeavePlan() The name of the LeavePlan the salary group is associated with.
String	getLocation() The name of the Location the salary group is associated with.
String	getObjectId()
BigDecimal	getPercentTime() Maximum percentage of time worked for the SalaryGroup.
String	getUserPrincipalId() The userPrincipalId of when this HrBusinessObject was last created/updated
Long	getVersionNumber()
boolean	isActive()
void	setActive(boolean active)
void	setBenefitsEligible(String benefitsEligible)
void	setCreateTime(org.joda.time.DateTime createTime)
void	setDescr(String descr)
void	setEffectiveKeySet(Set<EffectiveKey.Builder> effectiveKeySet)
void	setEffectiveLocalDate(org.joda.time.LocalDate effectiveLocalDate)
void	setGroupKeyCodeSet(Set<String> groupKeyCodeSet)
void	setGroupKeySet(Set<HrGroupKey.Builder> groupKeySet)
void	setHrSalGroup(String hrSalGroup)
void	setHrSalGroupId(String hrSalGroupId)
void	setId(String id)
void	setInstitution(String institution)
void	setLeaveEligible(String leaveEligible)
void	setLeavePlan(String leavePlan)
void	setLocation(String location)
void	setObjectId(String objectId)
void	setPercentTime(BigDecimal percentTime)
void	setUserPrincipalId(String userPrincipalId)
void	setVersionNumber(Long versionNumber)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static SalaryGroup.Builder create(String hrSalaryGroup)

create

public static SalaryGroup.Builder create(SalaryGroupContract contract)

build

public SalaryGroup build()

Specified by:

build in interface org.kuali.rice.core.api.mo.ModelBuilder

getBenefitsEligible

public String getBenefitsEligible()

Description copied from interface: SalaryGroupContract

Flag indicating if the SalaryGroup is eligible for benefits

benefitsEligible of a SalaryGroup

Specified by:

getBenefitsEligible in interface SalaryGroupContract

Returns:

Y if eligible for benefits, N if not

getPercentTime

public BigDecimal getPercentTime()

Description copied from interface: SalaryGroupContract

Maximum percentage of time worked for the SalaryGroup. When defining individual positions and jobs, the percent time will be less than the Salary Group's Percent Time. Percentage will be entered. Uses: leave accrual, payroll calculations, FTE reporting, etc... i.e. 40 hours per week is 100% percent time, 20 hours per week is 50% percent time

percentTime of a SalaryGroup

Specified by:

getPercentTime in interface SalaryGroupContract

Returns:

percentTime for SalaryGroup

getHrSalGroup

public String getHrSalGroup()

Description copied from interface: SalaryGroupContract

Text field used to identify the salary group

hrSalGroup of a SalaryGroup

Specified by:

getHrSalGroup in interface SalaryGroupContract

Returns:

hrSalGroup for SalaryGroup

getEffectiveKeySet

public Set<EffectiveKey.Builder> getEffectiveKeySet()

Description copied from interface: SalaryGroupContract

The set of EffectiveKeyContract objects that hold the aggregate "white-list" of groupkeys for this PostionReportGroupContract object.

Specified by:

getEffectiveKeySet in interface KpmeEffectiveKeyedSetDataTransferObject

Specified by:

getEffectiveKeySet in interface SalaryGroupContract

getLeaveEligible

public String getLeaveEligible()

Description copied from interface: SalaryGroupContract

Flag indicating if the SalaryGroup is eligible for leave benefits

leaveEligible of a SalaryGroup

Specified by:

getLeaveEligible in interface SalaryGroupContract

Returns:

Y if eligible for leave benefits, N if not

getHrSalGroupId

public String getHrSalGroupId()

Description copied from interface: SalaryGroupContract

The Primary Key of a SalaryGroup entry saved in a database

hrSalGroupId of a SalaryGroup

Specified by:

getHrSalGroupId in interface SalaryGroupContract

Returns:

hrSalGroupId for SalaryGroup

getDescr

public String getDescr()

Description copied from interface: SalaryGroupContract

Description of the salary group

descr of a SalaryGroup

Specified by:

getDescr in interface SalaryGroupContract

Returns:

descr for SalaryGroup

getInstitution

public String getInstitution()

Description copied from interface: SalaryGroupContract

The name of the institution the salary group is associated with.

institution of a SalaryGroup

Specified by:

getInstitution in interface SalaryGroupContract

Returns:

institution for SalaryGroup

getLeavePlan

public String getLeavePlan()

Description copied from interface: SalaryGroupContract

The name of the LeavePlan the salary group is associated with.

leavePlan of a SalaryGroup

Specified by:

getLeavePlan in interface SalaryGroupContract

Returns:

leavePlan for SalaryGroup

getLocation

public String getLocation()

Description copied from interface: SalaryGroupContract

The name of the Location the salary group is associated with.

location of a SalaryGroup

Specified by:

getLocation in interface SalaryGroupContract

Returns:

location for SalaryGroup

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

getGroupKeyCodeSet

public Set<String> getGroupKeyCodeSet()

Specified by:

getGroupKeyCodeSet in interface KeyedSetData

getGroupKeySet

public Set<HrGroupKey.Builder> getGroupKeySet()

Specified by:

getGroupKeySet in interface KeyedSetData

setBenefitsEligible

public void setBenefitsEligible(String benefitsEligible)

setPercentTime

public void setPercentTime(BigDecimal percentTime)

setHrSalGroup

public void setHrSalGroup(String hrSalGroup)

setEffectiveKeySet

public void setEffectiveKeySet(Set<EffectiveKey.Builder> effectiveKeySet)

setLeaveEligible

public void setLeaveEligible(String leaveEligible)

setHrSalGroupId

public void setHrSalGroupId(String hrSalGroupId)

setDescr

public void setDescr(String descr)

setInstitution

public void setInstitution(String institution)

setLeavePlan

public void setLeavePlan(String leavePlan)

setLocation

public void setLocation(String location)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)

setActive

public void setActive(boolean active)

setId

public void setId(String id)

setEffectiveLocalDate

public void setEffectiveLocalDate(org.joda.time.LocalDate effectiveLocalDate)

setCreateTime

public void setCreateTime(org.joda.time.DateTime createTime)

setUserPrincipalId

public void setUserPrincipalId(String userPrincipalId)

setGroupKeyCodeSet

public void setGroupKeyCodeSet(Set<String> groupKeyCodeSet)

setGroupKeySet

public void setGroupKeySet(Set<HrGroupKey.Builder> groupKeySet)