org.kuali.kpme.tklm.leave.block

Class LeaveBlock

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kpme.core.block.CalendarBlockBase

org.kuali.kpme.core.block.CalendarBlock

org.kuali.kpme.tklm.leave.block.LeaveBlock

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, Assignable, CalendarBlockContract, LeaveBlockContract, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject

Direct Known Subclasses:

LeaveBlockHistory

public class LeaveBlock
extends CalendarBlock
implements Assignable, LeaveBlockContract

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LeaveBlock.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_NAME
protected String	earnCode
protected Long	jobNumber
protected BigDecimal	leaveAmount
protected String	lmLeaveBlockId
protected Long	task
protected Long	workArea

Fields inherited from class org.kuali.kpme.core.block.CalendarBlockBase

amount, beginTimestamp, concreteBlockId, concreteBlockType, documentId, endTimestamp, hours, hrCalendarBlockId, lunchDeleted, overtimePref, principalId, timestamp

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Fields inherited from interface org.kuali.kpme.core.api.assignment.Assignable

ASSIGNABLE_TERM_NAME

Constructor Summary

Constructors

Constructor and Description
LeaveBlock()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAccrualCategory() The AccrualCategory name associated with the LeaveBlock
AccrualCategory	getAccrualCategoryObj()
AccrualCategoryRule	getAccrualCategoryRule()
String	getAccrualCategoryRuleId() The AccrualCategoryRuleId associated with the LeaveBlock
Boolean	getAccrualGenerated() The accrualGenerated flag to indicate if the accrual is generated or not
String	getAffectPay()
String	getAssignmentKey() The assignment key associated with the LeaveBlock
List<Assignment>	getAssignments()
String	getAssignmentTitle() The assignment title associated with the LeaveBlock
Date	getBeginDate()
org.joda.time.DateTime	getBeginDateTime() The begin timestamp (DateTime) associated with the LeaveBlock
Timestamp	getBeginTimestampVal()
Long	getBlockId() TODO: What is this used for? Different from lmLeaveBlockId?? The blockId associated with the LeaveBlock
String	getCalendarId() The calendar id associated with the LeaveBlock
String	getDescription() The description associated with the LeaveBlock
String	getDocumentStatus() The document status associated with the LeaveBlock
String	getEarnCode() The EarnCode name associated with the LeaveBlock
String	getEarnCodeDescription() The description of the earn code associated with the LeaveBlock
org.joda.time.DateTime	getEndDateTime() The end timestamp (DateTime) associated with the LeaveBlock
Timestamp	getEndTimestampVal()
Long	getJobNumber() The job number associated with the LeaveBlock
BigDecimal	getLeaveAmount() The leave amount associated with the LeaveBlock
List<LeaveBlockHistory>	getLeaveBlockHistories() The list of LeaveBlockHistory objects associated with the LeaveBlock
String	getLeaveBlockType() The type of leave block associated with the LeaveBlock
LeaveCalendarDocumentHeader	getLeaveCalendarDocumentHeader()
Date	getLeaveDate() The leave date (Date) associated with the LeaveBlock
org.joda.time.LocalDate	getLeaveLocalDate() The leave date (LocalDate) associated with the LeaveBlock
String	getLeaveRequestDocumentId() The document id of the leave request associated with the LeaveBlock
String	getLmLeaveBlockId() The primary key of a LeaveBlock entry saved in a database
String	getPlanningDescription() TODO: Put a better comment The planning description associated with the LeaveBlock
PrincipalHRAttributes	getPrincipalHRAttributes()
String	getPrincipalIdModified()
String	getReason() The reason associated with the LeaveBlock
String	getRequestStatus() The requestStatus associated with the LeaveBlock
String	getRequestStatusString() The value of requestStatus associated with the LeaveBlock
String	getScheduleTimeOffId() The scheduleTimeOffId associated with the LeaveBlock
Long	getTask() The task number associated with the LeaveBlock
String	getTransactionalDocId() TODO: Put a better comment The transactional document id associated with the LeaveBlock
String	getUserPrincipalId()
Long	getWorkArea() The workArea number associated with the LeaveBlock
int	hashCode()
boolean	isDeletable() Indicates if the principal has a permission to delete the leave block
boolean	isEditable() Indicates if the principal has a permission to edit a leave block
boolean	isSubmit() TODO: Put a better comment The submit flag of the LeaveBlock
void	setAccrualCategory(String accrualCategory)
void	setAccrualGenerated(Boolean accrualGenerated)
void	setAffectPay(String affectPay)
void	setAssignmentKey(String assignmentDescription)
void	setAssignmentTitle(String assignmentTitle)
void	setBeginDate(Date beginDate)
void	setBeginDateTime(org.joda.time.DateTime beginDateTime)
void	setBlockId(Long blockId)
void	setCalendarId(String calendarId)
void	setDescription(String description)
void	setDocumentStatus(String documentStatus)
void	setEarnCode(String earnCode)
void	setEndDateTime(org.joda.time.DateTime endDateTime)
void	setJobNumber(Long jobNumber)
void	setLeaveAmount(BigDecimal leaveAmount)
void	setLeaveBlockHistories(List<LeaveBlockHistory> leaveBlockHistories)
void	setLeaveBlockType(String leaveBlockType)
void	setLeaveCalendarDocumentHeader(LeaveCalendarDocumentHeader leaveCalendarDocumentHeader)
void	setLeaveDate(Date leaveDate)
void	setLeaveLocalDate(org.joda.time.LocalDate leaveLocalDate)
void	setLeaveRequestDocumentId(String leaveRequestDocumentId)
void	setLmLeaveBlockId(String lmLeaveBlockId)
void	setPlanningDescription(String planningDescription)
void	setPrincipalHRAttributes(PrincipalHRAttributes principalHRAttributes)
void	setPrincipalIdModified(String principalIdModified)
void	setReason(String reason)
void	setRequestStatus(String requestStatus)
void	setScheduleTimeOffId(String scheduleTimeOffId)
void	setSubmit(boolean submit)
void	setTask(Long task)
void	setTransactionDocId(String documentHeaderId)
void	setUserPrincipalId(String userPrincipalId)
void	setWorkArea(Long workArea)

Methods inherited from class org.kuali.kpme.core.block.CalendarBlock

getAmount, getBeginTimestamp, getConcreteBlockId, getConcreteBlockType, getDocumentId, getEndTimestamp, getHours, getLunchDeleted, getOvertimePref, getPrincipalId, getTimestamp, setAmount, setBeginTimestamp, setConcreteBlockId, setConcreteBlockType, setDocumentId, setEndTimestamp, setHours, setLunchDeleted, setOvertimePref, setPrincipalId, setTimestamp

Methods inherited from class org.kuali.kpme.core.block.CalendarBlockBase

getHrCalendarBlockId, setHrCalendarBlockId

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.kpme.core.api.block.CalendarBlockContract

getAmount, getBeginTimestamp, getConcreteBlockId, getConcreteBlockType, getDocumentId, getEndTimestamp, getHours, getHrCalendarBlockId, getLunchDeleted, getOvertimePref, getPrincipalId, getTimestamp, setAmount, setBeginTimestamp, setConcreteBlockId, setConcreteBlockType, setDocumentId, setEndTimestamp, setHours, setHrCalendarBlockId, setLunchDeleted, setOvertimePref, setPrincipalId, setTimestamp

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Field Detail

CACHE_NAME

public static final String CACHE_NAME

See Also:

Constant Field Values

earnCode

protected String earnCode

workArea

protected Long workArea

jobNumber

protected Long jobNumber

task

protected Long task

leaveAmount

protected BigDecimal leaveAmount

lmLeaveBlockId

protected String lmLeaveBlockId

Constructor Detail

LeaveBlock

public LeaveBlock()

Method Detail

getAccrualCategoryRuleId

public String getAccrualCategoryRuleId()

Description copied from interface: LeaveBlockContract

The AccrualCategoryRuleId associated with the LeaveBlock

It gets AccrualCategoryRule based on the AccrualCategory and PrincipalHRAttributes.

Specified by:

getAccrualCategoryRuleId in interface LeaveBlockContract

Returns:

lmAccrualCategoryRuleId if AccrualCategoryRule is not null

getAccrualCategory

public String getAccrualCategory()

Description copied from interface: LeaveBlockContract

The AccrualCategory name associated with the LeaveBlock

It gets AccrualCategory based on the principal id and leave local date.

Specified by:

getAccrualCategory in interface LeaveBlockContract

Returns:

accrualCategory for LeaveBlock

setAccrualCategory

public void setAccrualCategory(String accrualCategory)

getAccrualGenerated

public Boolean getAccrualGenerated()

Description copied from interface: LeaveBlockContract

The accrualGenerated flag to indicate if the accrual is generated or not

accrualGenerated of a LeaveBlock

Specified by:

getAccrualGenerated in interface LeaveBlockContract

Returns:

Y if accrual is generated, N if not

setAccrualGenerated

public void setAccrualGenerated(Boolean accrualGenerated)

isSubmit

public boolean isSubmit()

Description copied from interface: LeaveBlockContract

TODO: Put a better comment The submit flag of the LeaveBlock

submit of a LeaveBlock

Specified by:

isSubmit in interface LeaveBlockContract

Returns:

Y if submitted, N if not

setSubmit

public void setSubmit(boolean submit)

getBlockId

public Long getBlockId()

Description copied from interface: LeaveBlockContract

TODO: What is this used for? Different from lmLeaveBlockId?? The blockId associated with the LeaveBlock

blockId of a LeaveBlock

Specified by:

getBlockId in interface LeaveBlockContract

Returns:

blockId for LeaveBlock

setBlockId

public void setBlockId(Long blockId)

getDescription

public String getDescription()

Description copied from interface: LeaveBlockContract

The description associated with the LeaveBlock

description of a LeaveBlock

Specified by:

getDescription in interface LeaveBlockContract

Returns:

description for LeaveBlock

setDescription

public void setDescription(String description)

getLeaveDate

public Date getLeaveDate()

Description copied from interface: LeaveBlockContract

The leave date (Date) associated with the LeaveBlock

leaveDate of a LeaveBlock

Specified by:

getLeaveDate in interface LeaveBlockContract

Returns:

leaveDate for LeaveBlock

setLeaveDate

public void setLeaveDate(Date leaveDate)

getLeaveLocalDate

public org.joda.time.LocalDate getLeaveLocalDate()

Description copied from interface: LeaveBlockContract

The leave date (LocalDate) associated with the LeaveBlock

leaveDate of a LeaveBlock

Specified by:

getLeaveLocalDate in interface LeaveBlockContract

Returns:

leaveDate in LocalDate for LeaveBlock

setLeaveLocalDate

public void setLeaveLocalDate(org.joda.time.LocalDate leaveLocalDate)

getScheduleTimeOffId

public String getScheduleTimeOffId()

Description copied from interface: LeaveBlockContract

The scheduleTimeOffId associated with the LeaveBlock

scheduleTimeOffId of a LeaveBlock

Specified by:

getScheduleTimeOffId in interface LeaveBlockContract

Returns:

scheduleTimeOffId for LeaveBlock

setScheduleTimeOffId

public void setScheduleTimeOffId(String scheduleTimeOffId)

getRequestStatus

public String getRequestStatus()

Description copied from interface: LeaveBlockContract

The requestStatus associated with the LeaveBlock

requestStatus of a LeaveBlock

Specified by:

getRequestStatus in interface LeaveBlockContract

Returns:

requestStatus for LeaveBlock

setRequestStatus

public void setRequestStatus(String requestStatus)

getRequestStatusString

public String getRequestStatusString()

Description copied from interface: LeaveBlockContract

The value of requestStatus associated with the LeaveBlock

value of requestStatus of a LeaveBlock

Specified by:

getRequestStatusString in interface LeaveBlockContract

Returns:

value for requestStatus in REQUEST_STATUS_STRINGS map if found, "usage" if not found

getLeaveBlockHistories

public List<LeaveBlockHistory> getLeaveBlockHistories()

Description copied from interface: LeaveBlockContract

The list of LeaveBlockHistory objects associated with the LeaveBlock

leaveBlockHistories of a LeaveBlock

Specified by:

getLeaveBlockHistories in interface LeaveBlockContract

Returns:

leaveBlockHistories for LeaveBlock

setLeaveBlockHistories

public void setLeaveBlockHistories(List<LeaveBlockHistory> leaveBlockHistories)

getReason

public String getReason()

Description copied from interface: LeaveBlockContract

The reason associated with the LeaveBlock

reason of a LeaveBlock

Specified by:

getReason in interface LeaveBlockContract

Returns:

reason for LeaveBlock

setReason

public void setReason(String reason)

getAssignments

public List<Assignment> getAssignments()

Specified by:

getAssignments in interface Assignable

getAssignmentTitle

public String getAssignmentTitle()

Description copied from interface: LeaveBlockContract

The assignment title associated with the LeaveBlock

If the work area associated with the LeaveBlock is not null, it gets its description and its task. If the task is not null and not the default task, it gets the task description.

Specified by:

getAssignmentTitle in interface LeaveBlockContract

Returns:

"work area description - task description" for LeaveBlock

setAssignmentTitle

public void setAssignmentTitle(String assignmentTitle)

getCalendarId

public String getCalendarId()

Description copied from interface: LeaveBlockContract

The calendar id associated with the LeaveBlock

calendarId of a LeaveBlock

Specified by:

getCalendarId in interface LeaveBlockContract

Returns:

calendarId for LeaveBlock

setCalendarId

public void setCalendarId(String calendarId)

getEarnCodeDescription

public String getEarnCodeDescription()

Description copied from interface: LeaveBlockContract

The description of the earn code associated with the LeaveBlock

earnCodeObj.getDescription() of a LeaveBlock

Specified by:

getEarnCodeDescription in interface LeaveBlockContract

Returns:

earnCodeObj.getDescription() for LeaveBlock

getLeaveBlockType

public String getLeaveBlockType()

Description copied from interface: LeaveBlockContract

The type of leave block associated with the LeaveBlock

leaveBlockType of a LeaveBlock

Specified by:

getLeaveBlockType in interface LeaveBlockContract

Returns:

leaveBlockType for LeaveBlock

setLeaveBlockType

public void setLeaveBlockType(String leaveBlockType)

getLeaveCalendarDocumentHeader

public LeaveCalendarDocumentHeader getLeaveCalendarDocumentHeader()

setLeaveCalendarDocumentHeader

public void setLeaveCalendarDocumentHeader(LeaveCalendarDocumentHeader leaveCalendarDocumentHeader)

isEditable

public boolean isEditable()

Description copied from interface: LeaveBlockContract

Indicates if the principal has a permission to edit a leave block

Specified by:

isEditable in interface LeaveBlockContract

Returns:

Y if the principal has a permission to edit a leave block, N if not

isDeletable

public boolean isDeletable()

Description copied from interface: LeaveBlockContract

Indicates if the principal has a permission to delete the leave block

Specified by:

isDeletable in interface LeaveBlockContract

Returns:

Y if the principal has a permission to delete the leave block, N if not

getAssignmentKey

public String getAssignmentKey()

Description copied from interface: LeaveBlockContract

The assignment key associated with the LeaveBlock

The key is consisted of job number, work area number, and task number

Specified by:

getAssignmentKey in interface LeaveBlockContract

Returns:

assignmentKey for LeaveBlock

setAssignmentKey

public void setAssignmentKey(String assignmentDescription)

getDocumentStatus

public String getDocumentStatus()

Description copied from interface: LeaveBlockContract

The document status associated with the LeaveBlock

documentStatus of a LeaveBlock

Specified by:

getDocumentStatus in interface LeaveBlockContract

Returns:

documentStatus for LeaveBlock

setDocumentStatus

public void setDocumentStatus(String documentStatus)

getLeaveRequestDocumentId

public String getLeaveRequestDocumentId()

Description copied from interface: LeaveBlockContract

The document id of the leave request associated with the LeaveBlock

leaveRequestDocumentId of a LeaveBlock

Specified by:

getLeaveRequestDocumentId in interface LeaveBlockContract

Returns:

leaveRequestDocumentId for LeaveBlock

setLeaveRequestDocumentId

public void setLeaveRequestDocumentId(String leaveRequestDocumentId)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getPlanningDescription

public String getPlanningDescription()

Description copied from interface: LeaveBlockContract

TODO: Put a better comment The planning description associated with the LeaveBlock

planningDescription of a LeaveBlock

Specified by:

getPlanningDescription in interface LeaveBlockContract

Returns:

planningDescription for LeaveBlock

setPlanningDescription

public void setPlanningDescription(String planningDescription)

setTransactionDocId

public void setTransactionDocId(String documentHeaderId)

getTransactionalDocId

public String getTransactionalDocId()

Description copied from interface: LeaveBlockContract

TODO: Put a better comment The transactional document id associated with the LeaveBlock

transactionalDocId of a LeaveBlock

Specified by:

getTransactionalDocId in interface LeaveBlockContract

Returns:

transactionalDocId for LeaveBlock

getBeginDateTime

public org.joda.time.DateTime getBeginDateTime()

Description copied from interface: LeaveBlockContract

The begin timestamp (DateTime) associated with the LeaveBlock

beginTimestamp of a LeaveBlock

Specified by:

getBeginDateTime in interface LeaveBlockContract

Returns:

beginTimestamp for LeaveBlock

setBeginDateTime

public void setBeginDateTime(org.joda.time.DateTime beginDateTime)

getBeginDate

public Date getBeginDate()

getBeginTimestampVal

public Timestamp getBeginTimestampVal()

getEndTimestampVal

public Timestamp getEndTimestampVal()

setBeginDate

public void setBeginDate(Date beginDate)

getEndDateTime

public org.joda.time.DateTime getEndDateTime()

Description copied from interface: LeaveBlockContract

The end timestamp (DateTime) associated with the LeaveBlock

endTimestamp of a LeaveBlock

Specified by:

getEndDateTime in interface LeaveBlockContract

Returns:

endTimestamp for LeaveBlock

setEndDateTime

public void setEndDateTime(org.joda.time.DateTime endDateTime)

getLmLeaveBlockId

public String getLmLeaveBlockId()

Description copied from interface: LeaveBlockContract

The primary key of a LeaveBlock entry saved in a database

lmLeaveBlockId of a LeaveBlock

Specified by:

getLmLeaveBlockId in interface LeaveBlockContract

Returns:

lmLeaveBlockId for LeaveBlock

setLmLeaveBlockId

public void setLmLeaveBlockId(String lmLeaveBlockId)

getPrincipalIdModified

public String getPrincipalIdModified()

setPrincipalIdModified

public void setPrincipalIdModified(String principalIdModified)

getLeaveAmount

public BigDecimal getLeaveAmount()

Description copied from interface: LeaveBlockContract

The leave amount associated with the LeaveBlock

leaveAmount of a LeaveBlock

Specified by:

getLeaveAmount in interface LeaveBlockContract

Returns:

leaveAmount for LeaveBlock

setLeaveAmount

public void setLeaveAmount(BigDecimal leaveAmount)

getWorkArea

public Long getWorkArea()

Description copied from interface: LeaveBlockContract

The workArea number associated with the LeaveBlock

workArea of a LeaveBlock

Specified by:

getWorkArea in interface CalendarBlockContract

Specified by:

getWorkArea in interface LeaveBlockContract

Overrides:

getWorkArea in class CalendarBlock

Returns:

workArea for LeaveBlock

setWorkArea

public void setWorkArea(Long workArea)

Specified by:

setWorkArea in interface CalendarBlockContract

Overrides:

setWorkArea in class CalendarBlock

getJobNumber

public Long getJobNumber()

Description copied from interface: LeaveBlockContract

The job number associated with the LeaveBlock

jobNumber of a LeaveBlock

Specified by:

getJobNumber in interface CalendarBlockContract

Specified by:

getJobNumber in interface LeaveBlockContract

Overrides:

getJobNumber in class CalendarBlock

Returns:

jobNumber for LeaveBlock

setJobNumber

public void setJobNumber(Long jobNumber)

Specified by:

setJobNumber in interface CalendarBlockContract

Overrides:

setJobNumber in class CalendarBlock

getTask

public Long getTask()

Description copied from interface: LeaveBlockContract

The task number associated with the LeaveBlock

task of a LeaveBlock

Specified by:

getTask in interface CalendarBlockContract

Specified by:

getTask in interface LeaveBlockContract

Overrides:

getTask in class CalendarBlock

Returns:

task for LeaveBlock

setTask

public void setTask(Long task)

Specified by:

setTask in interface CalendarBlockContract

Overrides:

setTask in class CalendarBlock

getEarnCode

public String getEarnCode()

Description copied from interface: LeaveBlockContract

The EarnCode name associated with the LeaveBlock

earnCode of a LeaveBlock

Specified by:

getEarnCode in interface CalendarBlockContract

Specified by:

getEarnCode in interface LeaveBlockContract

Overrides:

getEarnCode in class CalendarBlock

Returns:

earnCode for LeaveBlock

setEarnCode

public void setEarnCode(String earnCode)

Specified by:

setEarnCode in interface CalendarBlockContract

Overrides:

setEarnCode in class CalendarBlock

getAccrualCategoryRule

public AccrualCategoryRule getAccrualCategoryRule()

getAccrualCategoryObj

public AccrualCategory getAccrualCategoryObj()

getPrincipalHRAttributes

public PrincipalHRAttributes getPrincipalHRAttributes()

setPrincipalHRAttributes

public void setPrincipalHRAttributes(PrincipalHRAttributes principalHRAttributes)

getUserPrincipalId

public String getUserPrincipalId()

setUserPrincipalId

public void setUserPrincipalId(String userPrincipalId)

Overrides:

setUserPrincipalId in class CalendarBlock

getAffectPay

public String getAffectPay()

setAffectPay

public void setAffectPay(String affectPay)