org.kuali.rice.kim.api.identity.employment
Class EntityEmploymentHistory

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kim.api.identity.employment.EntityEmploymentHistory

All Implemented Interfaces:

Serializable, Inactivatable, InactivatableFromTo, GloballyUnique, Historical, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, EntityEmploymentContract, EntityEmploymentHistoryContract

public final class EntityEmploymentHistory
extends AbstractDataTransferObject
implements EntityEmploymentHistoryContract

See Also:

Serialized Form

Nested Class Summary

static class

EntityEmploymentHistory.Builder A builder which can be used to construct EntityEmploymentHistory instances.

Method Summary

org.joda.time.DateTime	getActiveFromDate() Gets the date for which the record become active.
org.joda.time.DateTime	getActiveToDate() Gets the date for which the record become inactive.
KualiDecimal	getBaseSalaryAmount() Gets this EntityEmploymentContract's base salary amount.
String	getEmployeeId() Gets this EntityEmploymentContract's employee id.
CodedAttributeHistory	getEmployeeStatus() Gets this EntityEmploymentContract's employee status.
CodedAttributeHistory	getEmployeeType() Gets this EntityEmploymentContract's employee type.
String	getEmploymentRecordId() Gets this EntityEmploymentContract's employment record id.
EntityAffiliationHistory	getEntityAffiliation() Gets this EntityEmploymentContract's identity affiliation.
String	getEntityId() Gets this id of the parent identity object.
Long	getHistoryId()
String	getId() The unique identifier for an object.
String	getObjectId() Return the globally unique object id of this object.
String	getPrimaryDepartmentCode() Gets this EntityEmploymentContract's primary department code.
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.
boolean	isActive(org.joda.time.DateTime activeAsOf) Returns if the record is active for a given Time.
boolean	isActiveNow()
boolean	isPrimary() The primary value for this object.
boolean	isTenured() The tenure indicator value for this object.

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

getEntityId

public String getEntityId()

Description copied from interface: EntityEmploymentContract

Gets this id of the parent identity object.

Specified by:

getEntityId in interface EntityEmploymentContract

Returns:

the identity id for this EntityEmailContract

getEntityAffiliation

public EntityAffiliationHistory getEntityAffiliation()

Description copied from interface: EntityEmploymentHistoryContract

Gets this EntityEmploymentContract's identity affiliation.

Specified by:

getEntityAffiliation in interface EntityEmploymentContract

Specified by:

getEntityAffiliation in interface EntityEmploymentHistoryContract

Returns:

the identity affiliation for this EntityEmploymentContract, or null if none has been assigned.

getEmployeeStatus

public CodedAttributeHistory getEmployeeStatus()

Description copied from interface: EntityEmploymentHistoryContract

Gets this EntityEmploymentContract's employee status.

Specified by:

getEmployeeStatus in interface EntityEmploymentContract

Specified by:

getEmployeeStatus in interface EntityEmploymentHistoryContract

Returns:

the employee status for this EntityEmploymentContract, or null if none has been assigned.

getEmployeeType

public CodedAttributeHistory getEmployeeType()

Description copied from interface: EntityEmploymentHistoryContract

Gets this EntityEmploymentContract's employee type.

Specified by:

getEmployeeType in interface EntityEmploymentContract

Specified by:

getEmployeeType in interface EntityEmploymentHistoryContract

Returns:

the employee type for this EntityEmploymentContract, or null if none has been assigned.

getPrimaryDepartmentCode

public String getPrimaryDepartmentCode()

Description copied from interface: EntityEmploymentContract

Gets this EntityEmploymentContract's primary department code.

Specified by:

getPrimaryDepartmentCode in interface EntityEmploymentContract

Returns:

the primary department code for this EntityEmploymentContract, or null if none has been assigned.

getEmployeeId

public String getEmployeeId()

Description copied from interface: EntityEmploymentContract

Gets this EntityEmploymentContract's employee id.

Specified by:

getEmployeeId in interface EntityEmploymentContract

Returns:

the employee id for this EntityEmploymentContract, or null if none has been assigned.

getEmploymentRecordId

public String getEmploymentRecordId()

Description copied from interface: EntityEmploymentContract

Gets this EntityEmploymentContract's employment record id.

Specified by:

getEmploymentRecordId in interface EntityEmploymentContract

Returns:

the employment record id for this EntityEmploymentContract, or null if none has been assigned.

getBaseSalaryAmount

public KualiDecimal getBaseSalaryAmount()

Description copied from interface: EntityEmploymentContract

Gets this EntityEmploymentContract's base salary amount.

Specified by:

getBaseSalaryAmount in interface EntityEmploymentContract

Returns:

the base salary amount for this EntityEmploymentContract, or null if none has been assigned.

isPrimary

public boolean isPrimary()

Description copied from interface: EntityEmploymentContract

The primary value for this object.

Specified by:

isPrimary in interface EntityEmploymentContract

Returns:

returns true if the record is the primary Employment record for the parent entity

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet

getObjectId

public String getObjectId()

Description copied from interface: GloballyUnique

Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.

Specified by:

getObjectId in interface GloballyUnique

Returns:

the objectId of this object, or null if it has not been set yet

isActive

public boolean isActive()

Description copied from interface: Inactivatable

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

true if active false if not.

isTenured

public boolean isTenured()

Description copied from interface: EntityEmploymentContract

The tenure indicator value for this object.

Specified by:

isTenured in interface EntityEmploymentContract

Returns:

returns true if the record of Employment is tenured

getId

public String getId()

Description copied from interface: Identifiable

The unique identifier for an object. This can be null.

Specified by:

getId in interface Identifiable

Returns:

the id

getHistoryId

public Long getHistoryId()

Specified by:

getHistoryId in interface Historical

getActiveFromDate

public org.joda.time.DateTime getActiveFromDate()

Description copied from interface: InactivatableFromTo

Gets the date for which the record become active. Can be null.

Specified by:

getActiveFromDate in interface InactivatableFromTo

Returns:

Timestamp of active from date

getActiveToDate

public org.joda.time.DateTime getActiveToDate()

Description copied from interface: InactivatableFromTo

Gets the date for which the record become inactive. Can be null.

Specified by:

getActiveToDate in interface InactivatableFromTo

Returns:

Timestamp of active to date

isActiveNow

public boolean isActiveNow()

Specified by:

isActiveNow in interface Historical

isActive

public boolean isActive(org.joda.time.DateTime activeAsOf)

Description copied from interface: InactivatableFromTo

Returns if the record is active for a given Time. If the activeAsOfDate is null will return null.

Specified by:

isActive in interface InactivatableFromTo

Returns:

true if active false if not