org.kuali.kpme.tklm.time.timesheet

Class TimesheetDocument

java.lang.Object

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

org.kuali.kpme.tklm.time.timesheet.TimesheetDocument

All Implemented Interfaces:

Serializable, CalendarDocumentContract, TimesheetDocumentContract

public class TimesheetDocument
extends CalendarDocument
implements TimesheetDocumentContract

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TIMESHEET_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.

Constructor Summary

Constructors

Constructor and Description
TimesheetDocument(TimesheetDocumentHeader documentHeader)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getAssignmentDescriptions(boolean clockOnlyAssignments, org.joda.time.LocalDate date) TODO: Put a comment The map of assignment descriptions associated with the TimesheetDocument
Map<String,String>	getAssignmentDescriptionsOfApprovals(boolean clockOnlyAssignments)
TimesheetDocumentHeader	getDocumentHeader() The CalendarDocumentHeader object the CalendarDocument is associated with
String	getDocumentId() The document id of the document header associated with the TimesheetDocument
Map<String,List<org.joda.time.LocalDate>>	getEarnCodeMap() TODO: Put a better comment The map of earn code name and a list of begin date of time blocks associated with the TimesheetDocument
Job	getJob(Long jobNumber) The Job object associated with the jobNumber
List<Job>	getJobs() The list of Job objects associated with the TimesheetDocument
String	getPrincipalId() The principal id of the document header associated with the TimesheetDocument
List<TimeBlock>	getTimeBlocks() The list of TimeBlock objects associated with the TimesheetDocument
TimeSummary	getTimeSummary() The TimeSummary object associated with the TimesheetDocument
void	setDocumentHeader(TimesheetDocumentHeader documentHeader)
void	setJobs(List<Job> jobs)
void	setTimeBlocks(List<TimeBlock> timeBlocks)

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

getAllAssignments, getAsOfDate, getAssignment, getAssignmentDescriptions, getAssignmentMap, getCalendarEntry, getCalendarType, getDocEndDate, setAssignments, setCalendarEntry, setCalendarType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.kpme.tklm.api.time.timesheet.TimesheetDocumentContract

getDocEndDate

Methods inherited from interface org.kuali.kpme.core.api.document.calendar.CalendarDocumentContract

getAllAssignments, getAsOfDate, getAssignmentMap, getCalendarEntry

Field Detail

TIMESHEET_DOCUMENT_TYPE

public static final String TIMESHEET_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

TimesheetDocument

public TimesheetDocument(TimesheetDocumentHeader documentHeader)

Method Detail

getDocumentHeader

public TimesheetDocumentHeader 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(TimesheetDocumentHeader documentHeader)

getJobs

public List<Job> getJobs()

Description copied from interface: TimesheetDocumentContract

The list of Job objects associated with the TimesheetDocument

jobs of a TimesheetDocument

Specified by:

getJobs in interface TimesheetDocumentContract

Returns:

jobs for TimesheetDocument

setJobs

public void setJobs(List<Job> jobs)

getTimeBlocks

public List<TimeBlock> getTimeBlocks()

Description copied from interface: TimesheetDocumentContract

The list of TimeBlock objects associated with the TimesheetDocument

timeBlocks of a TimesheetDocument

Specified by:

getTimeBlocks in interface TimesheetDocumentContract

Returns:

timeBlocks for TimesheetDocument

setTimeBlocks

public void setTimeBlocks(List<TimeBlock> timeBlocks)

getTimeSummary

public TimeSummary getTimeSummary()

Description copied from interface: TimesheetDocumentContract

The TimeSummary object associated with the TimesheetDocument

timeSummary of a TimesheetDocument

Specified by:

getTimeSummary in interface TimesheetDocumentContract

Returns:

timeSummary for TimesheetDocument

getPrincipalId

public String getPrincipalId()

Description copied from interface: TimesheetDocumentContract

The principal id of the document header associated with the TimesheetDocument

getDocumentHeader().getPrincipalId() of a TimesheetDocument

Specified by:

getPrincipalId in interface TimesheetDocumentContract

Specified by:

getPrincipalId in class CalendarDocument

Returns:

getDocumentHeader().getPrincipalId() for TimesheetDocument

getJob

public Job getJob(Long jobNumber)

Description copied from interface: TimesheetDocumentContract

The Job object associated with the jobNumber

job associated with the jobNumber

Specified by:

getJob in interface TimesheetDocumentContract

Parameters:

jobNumber - number to retrieve Job object from jobNumberToJobMap

Returns:

Job object associated with the jobNumber

getDocumentId

public String getDocumentId()

Description copied from interface: TimesheetDocumentContract

The document id of the document header associated with the TimesheetDocument

this.getDocumentHeader().getDocumentId() of a TimesheetDocument

Specified by:

getDocumentId in interface TimesheetDocumentContract

Specified by:

getDocumentId in class CalendarDocument

Returns:

this.getDocumentHeader().getDocumentId() for TimesheetDocument

getEarnCodeMap

public Map<String,List<org.joda.time.LocalDate>> getEarnCodeMap()

Description copied from interface: TimesheetDocumentContract

TODO: Put a better comment The map of earn code name and a list of begin date of time blocks associated with the TimesheetDocument

earnCodeMap of a TimesheetDocument

Specified by:

getEarnCodeMap in interface TimesheetDocumentContract

Returns:

earnCodeMap for TimesheetDocument

getAssignmentDescriptions

public Map<String,String> getAssignmentDescriptions(boolean clockOnlyAssignments,
                                           org.joda.time.LocalDate date)

Description copied from interface: TimesheetDocumentContract

TODO: Put a comment The map of assignment descriptions associated with the TimesheetDocument

Specified by:

getAssignmentDescriptions in interface TimesheetDocumentContract

Returns:

assignmentDescriptions

getAssignmentDescriptionsOfApprovals

public Map<String,String> getAssignmentDescriptionsOfApprovals(boolean clockOnlyAssignments)