org.kuali.kpme.core.service.permission
Class HrPermissionServiceBase

java.lang.Object
  org.kuali.kpme.core.service.permission.HrPermissionServiceBase

Direct Known Subclasses:

HRPermissionServiceImpl, LMPermissionServiceImpl, TKPermissionServiceImpl

public abstract class HrPermissionServiceBase
extends Object

Constructor Summary

HrPermissionServiceBase()

Method Summary

DepartmentService	getDepartmentService()
org.kuali.rice.kim.api.type.KimTypeInfoService	getKimTypeInfoService()
protected List<org.kuali.rice.kim.api.permission.Permission>	getMatchingPermissions(List<org.kuali.rice.kim.api.permission.Permission> permissions, Map<String,String> permissionDetails) Compare each of the passed in permissions with the given permissionDetails.
org.kuali.rice.kim.api.permission.PermissionService	getPermissionService()
protected org.kuali.rice.kim.framework.permission.PermissionTypeService	getPermissionTypeService(org.kuali.rice.kim.api.common.template.Template permissionTemplate)
protected Map<String,org.kuali.rice.kim.framework.permission.PermissionTypeService>	getPermissionTypeServicesByTemplateId(Collection<org.kuali.rice.kim.api.permission.Permission> permissions)
org.kuali.rice.kim.api.role.RoleService	getRoleService()
WorkAreaService	getWorkAreaService()
protected Map<String,List<org.kuali.rice.kim.api.permission.Permission>>	groupPermissionsByTemplate(Collection<org.kuali.rice.kim.api.permission.Permission> permissions)
abstract boolean	isAuthorized(String principalId, String permissionName, Map<String,String> qualification, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform permissionName for the given role qualifications.
abstract boolean	isAuthorizedByTemplate(String principalId, String namespaceCode, String permissionTemplateName, Map<String,String> permissionDetails, Map<String,String> qualification, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given permission details and role qualifications.
protected boolean	isAuthorizedByTemplate(String principalId, String namespaceCode, String permissionTemplateName, String documentTypeName, String documentId, org.kuali.rice.kew.api.document.DocumentStatus documentStatus, Assignment assignment, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given document information.
protected boolean	isAuthorizedByTemplate(String principalId, String namespaceCode, String permissionTemplateName, String documentTypeName, String documentId, org.kuali.rice.kew.api.document.DocumentStatus documentStatus, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given document information.
protected boolean	isAuthorizedByTemplate(String principalId, String namespaceCode, String permissionTemplateName, String documentTypeName, String documentId, org.kuali.rice.kew.api.document.DocumentStatus documentStatus, List<Assignment> assignments, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given document information.
protected boolean	isAuthorizedByTemplate(String principalId, String namespaceCode, String permissionTemplateName, String documentTypeName, String documentId, org.kuali.rice.kew.api.document.DocumentStatus documentStatus, Map<String,String> qualification, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given document information and role qualifiers.
boolean	isAuthorizedByTemplateInDepartment(String principalId, String namespaceCode, String permissionTemplateName, String department, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given department.
protected boolean	isAuthorizedByTemplateInDepartment(String principalId, String namespaceCode, String permissionTemplateName, String department, String documentTypeName, String documentId, org.kuali.rice.kew.api.document.DocumentStatus documentStatus, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given department and document information.
boolean	isAuthorizedByTemplateInLocation(String principalId, String namespaceCode, String permissionTemplateName, String location, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given location.
protected boolean	isAuthorizedByTemplateInLocation(String principalId, String namespaceCode, String permissionTemplateName, String location, String documentTypeName, String documentId, org.kuali.rice.kew.api.document.DocumentStatus documentStatus, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given location and document information.
boolean	isAuthorizedByTemplateInWorkArea(String principalId, String namespaceCode, String permissionTemplateName, Long workArea, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given work area.
protected boolean	isAuthorizedByTemplateInWorkArea(String principalId, String namespaceCode, String permissionTemplateName, Long workArea, String documentTypeName, String documentId, org.kuali.rice.kew.api.document.DocumentStatus documentStatus, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given work area and document information.
boolean	isAuthorizedInDepartment(String principalId, String permissionName, String department, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform permissionName for the given department.
boolean	isAuthorizedInLocation(String principalId, String permissionName, String location, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform permissionName for the given location.
boolean	isAuthorizedInWorkArea(String principalId, String permissionName, Long workArea, org.joda.time.DateTime asOfDate) Checks whether the given principalId is authorized to perform permissionName for the given work area.
void	setDepartmentService(DepartmentService departmentService)
void	setKimTypeInfoService(org.kuali.rice.kim.api.type.KimTypeInfoService kimTypeInfoService)
void	setPermissionService(org.kuali.rice.kim.api.permission.PermissionService permissionService)
void	setRoleService(org.kuali.rice.kim.api.role.RoleService roleService)
void	setWorkAreaService(WorkAreaService workAreaService)

Methods inherited from class java.lang.Object

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

Constructor Detail

HrPermissionServiceBase

public HrPermissionServiceBase()

Method Detail

isAuthorized

public abstract boolean isAuthorized(String principalId,
                                     String permissionName,
                                     Map<String,String> qualification,
                                     org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform permissionName for the given role qualifications.

Parameters:

principalId - The person to check the permission for

permissionName - The name of the permission

qualification - The map of role qualifiers for the person

asOfDate - The effective date of the permission

Returns:

true if principalId is authorized to perform permissionName, false otherwise.

isAuthorizedByTemplate

public abstract boolean isAuthorizedByTemplate(String principalId,
                                               String namespaceCode,
                                               String permissionTemplateName,
                                               Map<String,String> permissionDetails,
                                               Map<String,String> qualification,
                                               org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given permission details and role qualifications.

Parameters:

principalId - The person to check the permission for

namespaceCode - The namespace for the permission template

permissionTemplateName - The name of the permission template

permissionDetails - The map of permission details for the permission

qualification - The map of role qualifiers for the person

asOfDate - The effective date of the permission

Returns:

true if principalId is authorized to perform any permission templated by permissionTemplateName, false otherwise.

isAuthorizedInWorkArea

public boolean isAuthorizedInWorkArea(String principalId,
                                      String permissionName,
                                      Long workArea,
                                      org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform permissionName for the given work area.

Parameters:

principalId - The person to check the permission for

permissionName - The name of the permission

workArea - The work area qualifier

asOfDate - The effective date of the permission

Returns:

true if principalId is authorized to perform permissionName for the given work area, false otherwise.

isAuthorizedInDepartment

public boolean isAuthorizedInDepartment(String principalId,
                                        String permissionName,
                                        String department,
                                        org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform permissionName for the given department.

Parameters:

principalId - The person to check the permission for

permissionName - The name of the permission

department - The department qualifier

asOfDate - The effective date of the permission

Returns:

true if principalId is authorized to perform permissionName for the given department, false otherwise.

isAuthorizedInLocation

public boolean isAuthorizedInLocation(String principalId,
                                      String permissionName,
                                      String location,
                                      org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform permissionName for the given location.

Parameters:

principalId - The person to check the permission for

permissionName - The name of the permission

location - The location qualifier

asOfDate - The effective date of the permission

Returns:

true if principalId is authorized to perform permissionName for the given location, false otherwise.

isAuthorizedByTemplateInWorkArea

public boolean isAuthorizedByTemplateInWorkArea(String principalId,
                                                String namespaceCode,
                                                String permissionTemplateName,
                                                Long workArea,
                                                org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given work area.

Parameters:

principalId - The person to check the permission for

namespaceCode - The namespace for the permission template

permissionTemplateName - The name of the permission template

workArea - The work area qualifier

asOfDate - The effective date of the permission

Returns:

true if principalId is authorized to perform any permission templated by permissionTemplateName for the given work area, false otherwise.

isAuthorizedByTemplateInDepartment

public boolean isAuthorizedByTemplateInDepartment(String principalId,
                                                  String namespaceCode,
                                                  String permissionTemplateName,
                                                  String department,
                                                  org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given department.

Parameters:

principalId - The person to check the permission for

namespaceCode - The namespace for the permission template

permissionTemplateName - The name of the permission template

department - The department qualifier

asOfDate - The effective date of the permission

Returns:

true if principalId is authorized to perform any permission templated by permissionTemplateName for the given department, false otherwise.

isAuthorizedByTemplateInLocation

public boolean isAuthorizedByTemplateInLocation(String principalId,
                                                String namespaceCode,
                                                String permissionTemplateName,
                                                String location,
                                                org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given location.

Parameters:

principalId - The person to check the permission for

namespaceCode - The namespace for the permission template

permissionTemplateName - The name of the permission template

location - The location qualifier

asOfDate - The effective date of the permission

Returns:

true if principalId is authorized to perform any permission templated by permissionTemplateName for the given location, false otherwise.

isAuthorizedByTemplate

protected boolean isAuthorizedByTemplate(String principalId,
                                         String namespaceCode,
                                         String permissionTemplateName,
                                         String documentTypeName,
                                         String documentId,
                                         org.kuali.rice.kew.api.document.DocumentStatus documentStatus,
                                         List<Assignment> assignments,
                                         org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given document information.

Parameters:

principalId - The person to check the permission for

namespaceCode - The namespace for the permission template

permissionTemplateName - The name of the permission template

documentTypeName - The type of the document

documentId - The id of the document

documentStatus - The status of the document

assignments - The list of assignments associated with the document

Returns:

true if principalId is authorized to perform any permission templated by permissionTemplateName for the given document information, false otherwise.

isAuthorizedByTemplate

protected boolean isAuthorizedByTemplate(String principalId,
                                         String namespaceCode,
                                         String permissionTemplateName,
                                         String documentTypeName,
                                         String documentId,
                                         org.kuali.rice.kew.api.document.DocumentStatus documentStatus,
                                         Assignment assignment,
                                         org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given document information.

Parameters:

principalId - The person to check the permission for

namespaceCode - The namespace for the permission template

permissionTemplateName - The name of the permission template

documentTypeName - The type of the document

documentId - The id of the document

documentStatus - The status of the document

assignment - The assignment associated with the document

Returns:

true if principalId is authorized to perform any permission templated by permissionTemplateName for the given document information, false otherwise.

isAuthorizedByTemplate

protected boolean isAuthorizedByTemplate(String principalId,
                                         String namespaceCode,
                                         String permissionTemplateName,
                                         String documentTypeName,
                                         String documentId,
                                         org.kuali.rice.kew.api.document.DocumentStatus documentStatus,
                                         org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given document information.

Parameters:

principalId - The person to check the permission for

namespaceCode - The namespace for the permission template

permissionTemplateName - The name of the permission template

documentTypeName - The type of the document

documentId - The id of the document

documentStatus - The status of the document

asOfDate - The effective date of the permission

Returns:

true if principalId is authorized to perform any permission templated by permissionTemplateName for the given document information, false otherwise.

isAuthorizedByTemplateInWorkArea

protected boolean isAuthorizedByTemplateInWorkArea(String principalId,
                                                   String namespaceCode,
                                                   String permissionTemplateName,
                                                   Long workArea,
                                                   String documentTypeName,
                                                   String documentId,
                                                   org.kuali.rice.kew.api.document.DocumentStatus documentStatus,
                                                   org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given work area and document information.

Parameters:

principalId - The person to check the permission for

namespaceCode - The namespace for the permission template

permissionTemplateName - The name of the permission template

workArea - The work area qualifier

documentTypeName - The type of the document

documentId - The id of the document

documentStatus - The status of the document

asOfDate - The effective date of the permission

Returns:

true if principalId is authorized to perform any permission templated by permissionTemplateName for the given work area and document information, false otherwise.

isAuthorizedByTemplateInDepartment

protected boolean isAuthorizedByTemplateInDepartment(String principalId,
                                                     String namespaceCode,
                                                     String permissionTemplateName,
                                                     String department,
                                                     String documentTypeName,
                                                     String documentId,
                                                     org.kuali.rice.kew.api.document.DocumentStatus documentStatus,
                                                     org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given department and document information.

Parameters:

principalId - The person to check the permission for

namespaceCode - The namespace for the permission template

permissionTemplateName - The name of the permission template

department - The department qualifier

documentTypeName - The type of the document

documentId - The id of the document

documentStatus - The status of the document

asOfDate - The effective date of the permission

Returns:

true if principalId is authorized to perform any permission templated by permissionTemplateName for the given department and document information, false otherwise.

isAuthorizedByTemplateInLocation

protected boolean isAuthorizedByTemplateInLocation(String principalId,
                                                   String namespaceCode,
                                                   String permissionTemplateName,
                                                   String location,
                                                   String documentTypeName,
                                                   String documentId,
                                                   org.kuali.rice.kew.api.document.DocumentStatus documentStatus,
                                                   org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given location and document information.

Parameters:

principalId - The person to check the permission for

namespaceCode - The namespace for the permission template

permissionTemplateName - The name of the permission template

location - The location qualifier

documentTypeName - The type of the document

documentId - The id of the document

documentStatus - The status of the document

asOfDate - The effective date of the permission

Returns:

true if principalId is authorized to perform any permission templated by permissionTemplateName for the given location and document information, false otherwise.

isAuthorizedByTemplate

protected boolean isAuthorizedByTemplate(String principalId,
                                         String namespaceCode,
                                         String permissionTemplateName,
                                         String documentTypeName,
                                         String documentId,
                                         org.kuali.rice.kew.api.document.DocumentStatus documentStatus,
                                         Map<String,String> qualification,
                                         org.joda.time.DateTime asOfDate)

Checks whether the given principalId is authorized to perform any permission templated by permissionTemplateName for the given document information and role qualifiers.

Parameters:

principalId - The person to check the permission for

namespaceCode - The namespace for the permission template

permissionTemplateName - The name of the permission template

documentTypeName - The type of the document

documentId - The id of the document

documentStatus - The status of the document

qualification - The map of role qualifiers for the person

asOfDate - The effective date of the permission

Returns:

true if principalId is authorized to perform any permission templated by permissionTemplateName for the given document information and role qualifiers, false otherwise.

getDepartmentService

public DepartmentService getDepartmentService()

setDepartmentService

public void setDepartmentService(DepartmentService departmentService)

getWorkAreaService

public WorkAreaService getWorkAreaService()

setWorkAreaService

public void setWorkAreaService(WorkAreaService workAreaService)

getPermissionService

public org.kuali.rice.kim.api.permission.PermissionService getPermissionService()

setPermissionService

public void setPermissionService(org.kuali.rice.kim.api.permission.PermissionService permissionService)

getMatchingPermissions

protected List<org.kuali.rice.kim.api.permission.Permission> getMatchingPermissions(List<org.kuali.rice.kim.api.permission.Permission> permissions,
                                                                                    Map<String,String> permissionDetails)

Compare each of the passed in permissions with the given permissionDetails. Those that match are added to the result list.

getPermissionTypeServicesByTemplateId

protected Map<String,org.kuali.rice.kim.framework.permission.PermissionTypeService> getPermissionTypeServicesByTemplateId(Collection<org.kuali.rice.kim.api.permission.Permission> permissions)

getPermissionTypeService

protected org.kuali.rice.kim.framework.permission.PermissionTypeService getPermissionTypeService(org.kuali.rice.kim.api.common.template.Template permissionTemplate)

groupPermissionsByTemplate

protected Map<String,List<org.kuali.rice.kim.api.permission.Permission>> groupPermissionsByTemplate(Collection<org.kuali.rice.kim.api.permission.Permission> permissions)

getKimTypeInfoService

public org.kuali.rice.kim.api.type.KimTypeInfoService getKimTypeInfoService()

setKimTypeInfoService

public void setKimTypeInfoService(org.kuali.rice.kim.api.type.KimTypeInfoService kimTypeInfoService)

getRoleService

public org.kuali.rice.kim.api.role.RoleService getRoleService()

setRoleService

public void setRoleService(org.kuali.rice.kim.api.role.RoleService roleService)