org.kuali.hr.time.roles.service
Interface TkRoleService

All Known Implementing Classes:

TkRoleServiceImpl

public interface TkRoleService

Method Summary

Set<String>	getActivePrincipalsForWorkAreas(Set<Long> workAreas, Date asOfDate) Provides a unique set of principal ids that have active assignments in the given work areas.
List<TkRole>	getDepartmentInactiveRoles(String department) Fetch all Inactive Roles for a given Department
List<TkRole>	getDepartmentInactiveRoles(String department, String roleName, Date asOfDate) Fetch all Inactive Roles for a given Department and Role Name as of a particular date
List<TkRole>	getDepartmentRoles(String department) Fetch all Roles for a given Department
List<TkRole>	getDepartmentRoles(String department, String roleName, Date asOfDate) Fetch all Roles for a given Department and Role Name as of a particular date
List<TkRole>	getInactiveRoles(String principalId, Date asOfDate) Fetch all inactive roles for a given Principal ID as of a particular date
TkRole	getInactiveRolesByPosition(String positionNumber)
List<TkRole>	getInActiveWorkAreaRoles(Long workArea) Fetch all Inactive Roles for a given work area
List<TkRole>	getInActiveWorkAreaRoles(Long workArea, String roleName, Date asOfDate) Fetch all Inactive Roles for a given work area and role name as of a particular date
List<TkRole>	getPositionRolesForWorkArea(Long workArea, Date asOfDate)
List<String>	getResponsibleParties(Assignment assignment, String roleName, Date asOfDate) Gets the list of principal IDs responsible for the provided assignment / role name combination.
TkRole	getRole(String tkRoleId) Fetches Role by primary key
List<TkRole>	getRoles(String principalId, Date asOfDate) Fetch all roles for a given Principal ID as of a particular date
List<TkRole>	getRoles(String principalId, Date asOfDate, String roleName, Long workArea, String department)
List<TkRole>	getRoles(String principalId, String roleName, Date asOfDate) Fetch all roles for a given Principal ID and Role Name as of a particular date
TkRole	getRolesByPosition(String positionNumber) Fetches Role by position number
List<TkRole>	getWorkAreaRoles(Long workArea) Fetch all Roles for a given Work Area
List<TkRole>	getWorkAreaRoles(Long workArea, String roleName, Date asOfDate) Fetch all Roles for a given work area and role name as of a particular date
Set<Long>	getWorkAreasForApprover(String principalId, Date asOfDate) Provides a unique set of work areas that this user is an approver for.
void	saveOrUpdate(List<TkRole> roles) Save or Update a List of TkRole objects
void	saveOrUpdate(TkRole role) Save or Update a given TkRole

Method Detail

getRoles

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

Fetch all roles for a given Principal ID as of a particular date

Parameters:

principalId -

asOfDate -

Returns:

getInactiveRoles

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

Fetch all inactive roles for a given Principal ID as of a particular date

Parameters:

principalId -

asOfDate -

Returns:

getRoles

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

Fetch all roles for a given Principal ID and Role Name as of a particular date

Parameters:

principalId -

roleName -

asOfDate -

Returns:

getWorkAreaRoles

@Cacheable(value="KPME/TkRole",
           key="\'workArea=\' + #p0")
List<TkRole> getWorkAreaRoles(Long workArea)

Fetch all Roles for a given Work Area

Parameters:

workArea -

Returns:

getWorkAreaRoles

@Cacheable(value="KPME/TkRole",
           key="\'workArea=\' + #p0 + \'|\' + \'roleName=\' + #p1 + \'|\' + \'asOfDate=\' + #p2")
List<TkRole> getWorkAreaRoles(Long workArea,
                                        String roleName,
                                        Date asOfDate)

Fetch all Roles for a given work area and role name as of a particular date

Parameters:

workArea -

roleName -

asOfDate -

Returns:

getInActiveWorkAreaRoles

@Cacheable(value="KPME/TkRole",
           key="\'{getInActiveWorkAreaRoles}\' + \'workArea=\' + #p0")
List<TkRole> getInActiveWorkAreaRoles(Long workArea)

Fetch all Inactive Roles for a given work area

Parameters:

workArea -

Returns:

getInActiveWorkAreaRoles

@Cacheable(value="KPME/TkRole",
           key="\'{getInActiveWorkAreaRoles}\' + \'workArea=\' + #p0 + \'|\' + \'roleName=\' + #p1 + \'|\' + \'asOfDate=\' + #p2")
List<TkRole> getInActiveWorkAreaRoles(Long workArea,
                                                String roleName,
                                                Date asOfDate)

Fetch all Inactive Roles for a given work area and role name as of a particular date

Parameters:

workArea -

roleName -

asOfDate -

Returns:

getDepartmentRoles

@Cacheable(value="KPME/TkRole",
           key="\'department=\' + #p0 + \'|\' + \'roleName=\' + #p1 + \'|\' + \'asOfDate=\' + #p2")
List<TkRole> getDepartmentRoles(String department,
                                          String roleName,
                                          Date asOfDate)

Fetch all Roles for a given Department and Role Name as of a particular date

Parameters:

department -

roleName -

asOfDate -

Returns:

getDepartmentInactiveRoles

@Cacheable(value="KPME/TkRole",
           key="\'{getDepartmentInactiveRoles}\' + \'department=\' + #p0 + \'|\' + \'roleName=\' + #p1 + \'|\' + \'asOfDate=\' + #p2")
List<TkRole> getDepartmentInactiveRoles(String department,
                                                  String roleName,
                                                  Date asOfDate)

Fetch all Inactive Roles for a given Department and Role Name as of a particular date

Parameters:

department -

roleName -

asOfDate -

Returns:

getDepartmentRoles

@Cacheable(value="KPME/TkRole",
           key="\'department=\' + #p0")
List<TkRole> getDepartmentRoles(String department)

Fetch all Roles for a given Department

Parameters:

department -

Returns:

getDepartmentInactiveRoles

@Cacheable(value="KPME/TkRole",
           key="\'{getDepartmentInactiveRoles}\' + \'department=\' + #p0")
List<TkRole> getDepartmentInactiveRoles(String department)

Fetch all Inactive Roles for a given Department

Parameters:

department -

Returns:

saveOrUpdate

@CacheEvict(value={"KPME/TkRole","KPME/TkRoleGroup"},
            allEntries=true)
void saveOrUpdate(TkRole role)

Save or Update a given TkRole

Parameters:

role -

saveOrUpdate

@CacheEvict(value={"KPME/TkRole","KPME/TkRoleGroup"},
            allEntries=true)
void saveOrUpdate(List<TkRole> roles)

Save or Update a List of TkRole objects

Parameters:

roles -

getResponsibleParties

List<String> getResponsibleParties(Assignment assignment,
                                   String roleName,
                                   Date asOfDate)

Gets the list of principal IDs responsible for the provided assignment / role name combination.

Parameters:

assignment - the assignment to query

roleName - The role we are interested in.

asOfDate - effective date

Returns:

getWorkAreasForApprover

@Cacheable(value="KPME/TkRole",
           key="\'{getWorkAreasForApprover}\' + \'principalId=\' + #p0 + \'|\' + \'asOfDate=\' + #p1")
Set<Long> getWorkAreasForApprover(String principalId,
                                            Date asOfDate)

Provides a unique set of work areas that this user is an approver for.

Parameters:

principalId - The principal to retrieve roles for.

asOfDate - effective date

Returns:

A Set of Long work area numbers.

getActivePrincipalsForWorkAreas

Set<String> getActivePrincipalsForWorkAreas(Set<Long> workAreas,
                                            Date asOfDate)

Provides a unique set of principal ids that have active assignments in the given work areas.

Parameters:

workAreas - A set of work area numbers.

asOfDate - effective date

Returns:

A Set of String principal IDs.

getRole

@Cacheable(value="KPME/TkRole",
           key="\'tkRoleId=\' + #p0")
TkRole getRole(String tkRoleId)

Fetches Role by primary key

getRolesByPosition

@Cacheable(value="KPME/TkRole",
           key="\'positionNumber=\' + #p0")
TkRole getRolesByPosition(String positionNumber)

Fetches Role by position number

getInactiveRolesByPosition

@Cacheable(value="KPME/TkRole",
           key="\'{getInactiveRolesByPosition}\' + \'positionNumber=\' + #p0")
TkRole getInactiveRolesByPosition(String positionNumber)

getPositionRolesForWorkArea

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

getRoles

@Cacheable(value="KPME/TkRole",
           key="\'principalId=\' + #p0+ \'|\' + \'asOfDate=\' + #p1+ \'|\' + \'roleName=\' + #p2+ \'|\' + \'workArea=\' + #p3+ \'|\' + \'department=\' + #p4")
List<TkRole> getRoles(String principalId,
                                Date asOfDate,
                                String roleName,
                                Long workArea,
                                String department)