org.kuali.hr.time.roles
Interface UserRoles

All Known Implementing Classes:

TkUserRoles

public interface UserRoles

Class to set the contract between Users and Roles.

Method Summary

boolean	canSubmitTimesheet(String docId)
boolean	canSubmitTimesheet(TimesheetDocument doc)
Set<String>	getActiveAssignmentIds() Provides a Set of Assignment ids that this user is active under.
Set<Long>	getApproverWorkAreas() Provides a set of WorkArea names that this user is an approver for.
Set<String>	getDepartmentViewOnlyDepartments() Provides a Set of Department names that this user is a departmental view only for.
Set<String>	getOrgAdminCharts() Provides a Set of chart names that this user is a chart administrator for.
Set<String>	getOrgAdminDepartments() Provides a Set of Department names that this user is a chart administrator for.
String	getPrincipalId()
Set<Long>	getReviewerWorkAreas() Provides a Set of WorkArea names that this user is a reviewer for.
boolean	isActiveEmployee() Does the current user have any active assignments?
boolean	isAnyApproverActive() Does the current user have any active approver roles? Approver roles attach at the WorkArea level.
boolean	isApproverForPerson(String principalId)
boolean	isApproverForTimesheet(String docId)
boolean	isApproverForTimesheet(TimesheetDocument doc) Indicates whether or not the current can approve the provided timesheet.
boolean	isDepartmentAdmin()
boolean	isDepartmentAdminForPerson(String principalId)
boolean	isDeptViewOnly()
boolean	isDeptViewOnlyForPerson(String principalId)
boolean	isDocumentReadable(String documentId)
boolean	isDocumentReadable(TimesheetDocument document)
boolean	isDocumentWritable(String documentId)
boolean	isDocumentWritable(TimesheetDocument document)
boolean	isGlobalViewOnly() Does the current user have the Global View Only role?
boolean	isLocationAdmin()
boolean	isLocationAdminForPerson(String principalId)
boolean	isSynchronous() Does the current user have an assignment that is marked synchronous?
boolean	isSystemAdmin() Is the current user a system administrator?
boolean	isTimesheetApprover() Does the current user have any role that grants permission to approve timesheets?
boolean	isTimesheetReviewer()
boolean	isTimesheetReviewerForPerson(String principalId)

Method Detail

isLocationAdmin

boolean isLocationAdmin()

isDepartmentAdmin

boolean isDepartmentAdmin()

getPrincipalId

String getPrincipalId()

isTimesheetReviewer

boolean isTimesheetReviewer()

isSystemAdmin

boolean isSystemAdmin()

Is the current user a system administrator?

Returns:

true if yes, false otherwise

isActiveEmployee

boolean isActiveEmployee()

Does the current user have any active assignments?

Returns:

true if yes, false otherwise.

isAnyApproverActive

boolean isAnyApproverActive()

Does the current user have any active approver roles? Approver roles attach at the WorkArea level.

Returns:

true if yes, false otherwise.

isTimesheetApprover

boolean isTimesheetApprover()

Does the current user have any role that grants permission to approve timesheets?

Returns:

true if yes, false otherwise.

isGlobalViewOnly

boolean isGlobalViewOnly()

Does the current user have the Global View Only role?

Returns:

true if yes, false otherwise.

isSynchronous

boolean isSynchronous()

Does the current user have an assignment that is marked synchronous?

Returns:

true if yes, false otherwise.

getApproverWorkAreas

Set<Long> getApproverWorkAreas()

Provides a set of WorkArea names that this user is an approver for.

Returns:

a Set of workarea names.

getReviewerWorkAreas

Set<Long> getReviewerWorkAreas()

Provides a Set of WorkArea names that this user is a reviewer for.

Returns:

a Set of workarea names.

getActiveAssignmentIds

Set<String> getActiveAssignmentIds()

Provides a Set of Assignment ids that this user is active under.

Returns:

a Set of assignment object ids.

getDepartmentViewOnlyDepartments

Set<String> getDepartmentViewOnlyDepartments()

Provides a Set of Department names that this user is a departmental view only for.

Returns:

a Set of Department names.

getOrgAdminDepartments

Set<String> getOrgAdminDepartments()

Provides a Set of Department names that this user is a chart administrator for.

Returns:

a Set of Department names.

getOrgAdminCharts

Set<String> getOrgAdminCharts()

Provides a Set of chart names that this user is a chart administrator for.

Returns:

a Set of Chart names.

isDeptViewOnly

boolean isDeptViewOnly()

isApproverForTimesheet

boolean isApproverForTimesheet(TimesheetDocument doc)

Indicates whether or not the current can approve the provided timesheet.

Parameters:

doc - The TimesheetDocument in question.

Returns:

true if the doc can be approved by the current user.

isApproverForTimesheet

boolean isApproverForTimesheet(String docId)

canSubmitTimesheet

boolean canSubmitTimesheet(TimesheetDocument doc)

canSubmitTimesheet

boolean canSubmitTimesheet(String docId)

isDocumentReadable

boolean isDocumentReadable(TimesheetDocument document)

isDocumentReadable

boolean isDocumentReadable(String documentId)

isDocumentWritable

boolean isDocumentWritable(TimesheetDocument document)

isDocumentWritable

boolean isDocumentWritable(String documentId)

isApproverForPerson

boolean isApproverForPerson(String principalId)

isDepartmentAdminForPerson

boolean isDepartmentAdminForPerson(String principalId)

isDeptViewOnlyForPerson

boolean isDeptViewOnlyForPerson(String principalId)

isLocationAdminForPerson

boolean isLocationAdminForPerson(String principalId)

isTimesheetReviewerForPerson

boolean isTimesheetReviewerForPerson(String principalId)