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

java.lang.Object
  extended by org.kuali.rice.kim.api.identity.employment.EntityEmployment
All Implemented Interfaces:
Serializable, ImmutableInactivatable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, EntityEmploymentContract

public final class EntityEmployment
extends Object
implements ModelObjectComplete, EntityEmploymentContract

See Also:
Serialized Form

Nested Class Summary
static class EntityEmployment.Builder
          A builder which can be used to construct EntityEmployment instances.
(package private) static class EntityEmployment.Constants
          Defines some internal constants used on this class.
(package private) static class EntityEmployment.Elements
          A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.
 
Field Summary
private  Collection<Element> _futureElements
           
private  boolean active
           
private  KualiDecimal baseSalaryAmount
           
private  String employeeId
           
private  Type employeeStatus
           
private  Type employeeType
           
private  String employmentRecordId
           
private  EntityAffiliation entityAffiliation
           
private  String entityId
           
private  String id
           
private  String objectId
           
private  boolean primary
           
private  String primaryDepartmentCode
           
private  Long versionNumber
           
 
Constructor Summary
private EntityEmployment()
          Private constructor used only by JAXB.
private EntityEmployment(EntityEmployment.Builder builder)
           
 
Method Summary
 boolean equals(Object object)
          All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.
 KualiDecimal getBaseSalaryAmount()
          Gets this EntityEmploymentContract's base salary amount.
 String getEmployeeId()
          Gets this EntityEmploymentContract's employee id.
 Type getEmployeeStatus()
          Gets this EntityEmploymentContract's employee status.
 Type getEmployeeType()
          Gets this EntityEmploymentContract's employee type.
 String getEmploymentRecordId()
          Gets this EntityEmploymentContract's employment record id.
 EntityAffiliation getEntityAffiliation()
          Gets this EntityEmploymentContract's identity affiliation.
 String getEntityId()
          Gets this id of the parent identity object.
 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.
 int hashCode()
          All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.
 boolean isActive()
          The active indicator for an object.
 boolean isPrimary()
          The primary value for this object.
 String toString()
          This will return a proper string representation of the Model Object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

id

private final String id

entityId

private final String entityId

entityAffiliation

private final EntityAffiliation entityAffiliation

employeeStatus

private final Type employeeStatus

employeeType

private final Type employeeType

primaryDepartmentCode

private final String primaryDepartmentCode

employeeId

private final String employeeId

employmentRecordId

private final String employmentRecordId

baseSalaryAmount

private final KualiDecimal baseSalaryAmount

primary

private final boolean primary

versionNumber

private final Long versionNumber

objectId

private final String objectId

active

private final boolean active

_futureElements

private final Collection<Element> _futureElements
Constructor Detail

EntityEmployment

private EntityEmployment()
Private constructor used only by JAXB.


EntityEmployment

private EntityEmployment(EntityEmployment.Builder builder)
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 EntityAffiliation getEntityAffiliation()
Description copied from interface: EntityEmploymentContract
Gets this EntityEmploymentContract's identity affiliation.

Specified by:
getEntityAffiliation in interface EntityEmploymentContract
Returns:
the identity affiliation for this EntityEmploymentContract, or null if none has been assigned.

getEmployeeStatus

public Type getEmployeeStatus()
Description copied from interface: EntityEmploymentContract
Gets this EntityEmploymentContract's employee status.

Specified by:
getEmployeeStatus in interface EntityEmploymentContract
Returns:
the employee status for this EntityEmploymentContract, or null if none has been assigned.

getEmployeeType

public Type getEmployeeType()
Description copied from interface: EntityEmploymentContract
Gets this EntityEmploymentContract's employee type.

Specified by:
getEmployeeType in interface EntityEmploymentContract
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: ImmutableInactivatable
The active indicator for an object.

Specified by:
isActive in interface ImmutableInactivatable
Returns:
true if active false if not.

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

hashCode

public int hashCode()
Description copied from interface: ModelObjectComplete
All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.

Specified by:
hashCode in interface ModelObjectComplete
Overrides:
hashCode in class Object
Returns:
the hashCode value

equals

public boolean equals(Object object)
Description copied from interface: ModelObjectComplete
All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.

Specified by:
equals in interface ModelObjectComplete
Overrides:
equals in class Object
Parameters:
object - to object to compare for equality
Returns:
if equal

toString

public String toString()
Description copied from interface: ModelObjectBasic
This will return a proper string representation of the Model Object. All of the fields comprising the "public" api should be represented in the return value.

Specified by:
toString in interface ModelObjectBasic
Overrides:
toString in class Object
Returns:
the string representation


Copyright © 2004-2011 The Kuali Foundation. All Rights Reserved.