org.kuali.kpme.tklm.leave.calendar

Class LeaveCalendarDocument

java.lang.Object

org.kuali.kpme.core.document.calendar.CalendarDocument

org.kuali.kpme.tklm.leave.calendar.LeaveCalendarDocument

All Implemented Interfaces:

Serializable, Assignable, CalendarDocumentContract, LeaveCalendarDocumentContract

public class LeaveCalendarDocument
extends CalendarDocument
implements Assignable, LeaveCalendarDocumentContract

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	LEAVE_CALENDAR_DOCUMENT_TYPE This static member is needed by document search, to trigger the correct calendar document opening when clicking on a doc id link in the search results.

Fields inherited from class org.kuali.kpme.core.document.calendar.CalendarDocument

asOfDate, assignments, calendarEntry, calendarType, documentHeader

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

ASSIGNABLE_TERM_NAME

Constructor Summary

Constructors

Constructor and Description
LeaveCalendarDocument(CalendarEntry calendarEntry)
LeaveCalendarDocument(LeaveCalendarDocumentHeader documentHeader)

Method Summary

Methods

Modifier and Type	Method and Description
org.joda.time.LocalDate	getAsOfDate() The beginning date of the calendar entry the CalendarDocument is associated with
List<Assignment>	getAssignments() The list of Assignment objects the CalendarDocument is associated with
CalendarEntry	getCalendarEntry() The CalendarEntry object the CalendarDocument is associated with
org.joda.time.LocalDate	getDocEndDate() The end date of calendar entry associated with the LeaveCalendarDocument
LeaveCalendarDocumentHeader	getDocumentHeader() The CalendarDocumentHeader object the CalendarDocument is associated with
String	getDocumentId() The document id associated with the LeaveCalendarDocument
List<LeaveBlock>	getLeaveBlocks() The list of LeaveBlock objects associated with the LeaveCalendarDocument
String	getPrincipalId() The principal id associated with the LeaveCalendarDocument
void	setAssignments(List<Assignment> assignments)
void	setCalendarEntry(CalendarEntry calendarEntry)
void	setDocumentHeader(LeaveCalendarDocumentHeader documentHeader)
void	setLeaveBlocks(List<LeaveBlock> leaveBlocks)

Methods inherited from class org.kuali.kpme.core.document.calendar.CalendarDocument

getAssignment, getAssignmentDescriptions, getCalendarType, setCalendarType

Methods inherited from class java.lang.Object

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

Field Detail

LEAVE_CALENDAR_DOCUMENT_TYPE

public static final String LEAVE_CALENDAR_DOCUMENT_TYPE

This static member is needed by document search, to trigger the correct calendar document opening when clicking on a doc id link in the search results. It is distinguished from "HrConstants.LEAVE_CALENDAR_TYPE".

See Also:

Constant Field Values

Constructor Detail

LeaveCalendarDocument

public LeaveCalendarDocument(CalendarEntry calendarEntry)

LeaveCalendarDocument

public LeaveCalendarDocument(LeaveCalendarDocumentHeader documentHeader)

Method Detail

getDocumentHeader

public LeaveCalendarDocumentHeader getDocumentHeader()

Description copied from interface: CalendarDocumentContract

The CalendarDocumentHeader object the CalendarDocument is associated with

documentHeader of a CalendarDocument

Specified by:

getDocumentHeader in interface CalendarDocumentContract

Specified by:

getDocumentHeader in class CalendarDocument

Returns:

documentHeader of CalendarDocument

setDocumentHeader

public void setDocumentHeader(LeaveCalendarDocumentHeader documentHeader)

getLeaveBlocks

public List<LeaveBlock> getLeaveBlocks()

Description copied from interface: LeaveCalendarDocumentContract

The list of LeaveBlock objects associated with the LeaveCalendarDocument

leaveBlocks of a LeaveCalendarDocument

Specified by:

getLeaveBlocks in interface LeaveCalendarDocumentContract

Returns:

leaveBlocks for LeaveCalendarDocument

setLeaveBlocks

public void setLeaveBlocks(List<LeaveBlock> leaveBlocks)

getCalendarEntry

public CalendarEntry getCalendarEntry()

Description copied from interface: CalendarDocumentContract

The CalendarEntry object the CalendarDocument is associated with

calendarEntry of a CalendarDocument

Specified by:

getCalendarEntry in interface CalendarDocumentContract

Specified by:

getCalendarEntry in class CalendarDocument

Returns:

calendarEntry of CalendarDocument

setCalendarEntry

public void setCalendarEntry(CalendarEntry calendarEntry)

getPrincipalId

public String getPrincipalId()

Description copied from interface: LeaveCalendarDocumentContract

The principal id associated with the LeaveCalendarDocument

getDocumentHeader().getPrincipalId() of a LeaveCalendarDocument

Specified by:

getPrincipalId in interface LeaveCalendarDocumentContract

Overrides:

getPrincipalId in class CalendarDocument

Returns:

getDocumentHeader().getPrincipalId() for LeaveCalendarDocument

getDocumentId

public String getDocumentId()

Description copied from interface: LeaveCalendarDocumentContract

The document id associated with the LeaveCalendarDocument

getDocumentHeader().getDocumentId() of a LeaveCalendarDocument

Specified by:

getDocumentId in interface LeaveCalendarDocumentContract

Overrides:

getDocumentId in class CalendarDocument

Returns:

getDocumentHeader().getDocumentId() for LeaveCalendarDocument

getAssignments

public List<Assignment> getAssignments()

Description copied from interface: CalendarDocumentContract

The list of Assignment objects the CalendarDocument is associated with

assignments of a CalendarDocument

Specified by:

getAssignments in interface Assignable

Specified by:

getAssignments in interface CalendarDocumentContract

Specified by:

getAssignments in class CalendarDocument

Returns:

assignments of CalendarDocument

setAssignments

public void setAssignments(List<Assignment> assignments)

getAsOfDate

public org.joda.time.LocalDate getAsOfDate()

Description copied from interface: CalendarDocumentContract

The beginning date of the calendar entry the CalendarDocument is associated with

asOfDate of a CalendarDocument

Specified by:

getAsOfDate in interface CalendarDocumentContract

Specified by:

getAsOfDate in class CalendarDocument

Returns:

asOfDate of CalendarDocument

getDocEndDate

public org.joda.time.LocalDate getDocEndDate()

Description copied from interface: LeaveCalendarDocumentContract

The end date of calendar entry associated with the LeaveCalendarDocument

calendar entry end date of a LeaveCalendarDocument

Specified by:

getDocEndDate in interface LeaveCalendarDocumentContract

Returns:

getCalendarEntry().getEndPeriodFullDateTime().toLocalDate() for LeaveCalendarDocument