org.kuali.hr.time.assignment.service
Interface AssignmentService

All Known Implementing Classes:

AssignmentServiceImpl

public interface AssignmentService

Method Summary

List<Assignment>	getActiveAssignments(Date asOfDate) Get active assignments for all users for the current date CAUTION this method will return a lot of data in a normal production env It is intended to only be used in a batch setting
List<Assignment>	getActiveAssignmentsForJob(String principalId, Long jobNumber, Date asOfDate) KPME-1129 Kagata Get a list of active assignments based on principalId and jobNumber as of a particular date
List<Assignment>	getActiveAssignmentsForWorkArea(Long workArea, Date asOfDate) Get all active assignments for a work area
Assignment	getAssignment(AssignmentDescriptionKey key, Date asOfDate) For a given AssignmentDescriptionKey return the matching assignment.
Assignment	getAssignment(String tkAssignmentId) Reverse lookup of an assignment based on the assignment id
Assignment	getAssignment(String principalId, AssignmentDescriptionKey key, Date asOfDate) Fetch principal id and key as of a particular date
Assignment	getAssignment(TimesheetDocument timesheetDocument, String assignmentKey) Reverse lookup of an assignment based on the assignment key and the document
AssignmentDescriptionKey	getAssignmentDescriptionKey(String assignmentDesc) Get Assignment Description key based off of description
Map<String,String>	getAssignmentDescriptions(Assignment assignment) Get all assignment descriptions for an assignment
Map<String,String>	getAssignmentDescriptions(TimesheetDocument td, boolean clockOnlyAssignments) Get all assignment descriptions for a document
List<Assignment>	getAssignments(String principalId, Date asOfDate) Fetches a list of Assignments for a given principal Id as of a particular date
List<Assignment>	getAssignmentsByPayEntry(String principalId, CalendarEntries payCalendarEntry) Get assignments by pay calendar entry
Assignment	getMaxTimestampAssignment(String principalId)
List<Assignment>	searchAssignments(Date fromEffdt, Date toEffdt, String principalId, String jobNumber, String dept, String workArea, String active, String showHistory)

Method Detail

getAssignments

@Cacheable(value="KPME/Assignment",
           key="\'principalId=\' + #p0 + \'|\' + \'asOfDate=\' + #p1")
List<Assignment> getAssignments(String principalId,
                                          Date asOfDate)

Fetches a list of Assignments for a given principal Id as of a particular date

Parameters:

principalId -

asOfDate -

Returns:

getAssignment

Assignment getAssignment(TimesheetDocument timesheetDocument,
                         String assignmentKey)

Reverse lookup of an assignment based on the assignment key and the document

Parameters:

timesheetDocument -

assignmentKey -

Returns:

getAssignment

@Cacheable(value="KPME/Assignment",
           key="\'tkAssignmentId=\' + #p0")
Assignment getAssignment(String tkAssignmentId)

Reverse lookup of an assignment based on the assignment id

Parameters:

tkAssignmentId -

Returns:

getAssignmentDescriptionKey

AssignmentDescriptionKey getAssignmentDescriptionKey(String assignmentDesc)

Get Assignment Description key based off of description

Parameters:

assignmentDesc -

Returns:

getAssignmentDescriptions

Map<String,String> getAssignmentDescriptions(TimesheetDocument td,
                                             boolean clockOnlyAssignments)

Get all assignment descriptions for a document

Parameters:

td -

clockOnlyAssignments -

Returns:

getAssignmentDescriptions

Map<String,String> getAssignmentDescriptions(Assignment assignment)

Get all assignment descriptions for an assignment

Parameters:

assignment -

Returns:

getActiveAssignmentsForWorkArea

@Cacheable(value="KPME/Assignment",
           key="\'workArea=\' + #p0 + \'|\' + \'asOfDate=\' + #p1")
List<Assignment> getActiveAssignmentsForWorkArea(Long workArea,
                                                           Date asOfDate)

Get all active assignments for a work area

Parameters:

workArea -

asOfDate -

Returns:

getActiveAssignments

@Cacheable(value="KPME/Assignment",
           key="\'asOfDate=\' + #p0")
List<Assignment> getActiveAssignments(Date asOfDate)

Get active assignments for all users for the current date CAUTION this method will return a lot of data in a normal production env It is intended to only be used in a batch setting

Parameters:

asOfDate -

Returns:

getAssignment

Assignment getAssignment(AssignmentDescriptionKey key,
                         Date asOfDate)

For a given AssignmentDescriptionKey return the matching assignment.

Parameters:

key -

Returns:

getAssignment

Assignment getAssignment(String principalId,
                         AssignmentDescriptionKey key,
                         Date asOfDate)

Fetch principal id and key as of a particular date

Parameters:

principalId -

key -

asOfDate -

Returns:

getAssignmentsByPayEntry

List<Assignment> getAssignmentsByPayEntry(String principalId,
                                          CalendarEntries payCalendarEntry)

Get assignments by pay calendar entry

Parameters:

principalId -

payCalendarEntry -

Returns:

getActiveAssignmentsForJob

@Cacheable(value="KPME/Assignment",
           key="\'principalId=\' + #p0 + \'|\' + \'jobNumber=\' + #p1 + \'|\' + \'asOfDate=\' + #p2")
List<Assignment> getActiveAssignmentsForJob(String principalId,
                                                      Long jobNumber,
                                                      Date asOfDate)

KPME-1129 Kagata Get a list of active assignments based on principalId and jobNumber as of a particular date

Parameters:

principalId -

jobNumber -

asOfDate -

Returns:

searchAssignments

List<Assignment> searchAssignments(Date fromEffdt,
                                   Date toEffdt,
                                   String principalId,
                                   String jobNumber,
                                   String dept,
                                   String workArea,
                                   String active,
                                   String showHistory)

getMaxTimestampAssignment

Assignment getMaxTimestampAssignment(String principalId)