org.kuali.rice.kim.service
Interface ResponsibilityService

All Known Implementing Classes:

ResponsibilityServiceImpl

public interface ResponsibilityService

This service provides operations for determining what responsibility actions a principal has and for querying about responsibility data.

A responsibility represents an action that a principal is requested to take. This is used for defining workflow actions (such as approve, acknowledge, fyi) that the principal has the responsibility to take. The workflow engine integrates with this service to provide responsibility-driven routing.

A responsibility is very similar to a permission in a couple of ways. First of all, responsibilities are always granted to a role, never assigned directly to a principal or group. Furthermore, in a similar fashion to permissions, a role has the concept of a responsibility template. The responsibility template specifies what additional responsibility details need to be defined when the responsibility is created.

This service provides read-only operations. For write operations, see ResponsibilityUpdateService.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

ResponsibilityUpdateService

Method Summary

boolean	areActionsAtAssignmentLevel(KimResponsibilityInfo responsibility) Lets the system know (mainly for UI purposes) whether this responsibility expects RoleResponsibilityAction records to be given at the assignment level or are global to the responsibility.
boolean	areActionsAtAssignmentLevelById(String responsibilityId) Lets the system know (mainly for UI purposes) whether this responsibility expects RoleResponsibilityAction records to be given at the assignment level or are global to the responsibility.
List<KimResponsibilityInfo>	getResponsibilitiesByName(String namespaceCode, String responsibilityName) Return the responsibility object for the given unique combination of namespace, component and responsibility name.
KimResponsibilityInfo	getResponsibility(String responsibilityId) Get the responsibility object with the given ID.
List<ResponsibilityActionInfo>	getResponsibilityActions(String namespaceCode, String responsibilityName, AttributeSet qualification, AttributeSet responsibilityDetails)
List<ResponsibilityActionInfo>	getResponsibilityActionsByTemplateName(String namespaceCode, String responsibilityTemplateName, AttributeSet qualification, AttributeSet responsibilityDetails)
KimResponsibilityTemplateInfo	getResponsibilityTemplate(String responsibilityTemplateId)
KimResponsibilityTemplateInfo	getResponsibilityTemplateByName(String namespaceCode, String responsibilityTemplateName)
List<String>	getRoleIdsForResponsibility(KimResponsibilityInfo responsibility, AttributeSet qualification) Get the role IDs associated with the given responsibility.
boolean	hasResponsibility(String principalId, String namespaceCode, String responsibilityName, AttributeSet qualification, AttributeSet responsibilityDetails) Check whether the principal has the given responsibility within the passed qualifier.
boolean	hasResponsibilityByTemplateName(String principalId, String namespaceCode, String responsibilityTemplateName, AttributeSet qualification, AttributeSet responsibilityDetails) Check whether the principal has the given responsibility within the passed qualifier.
List<? extends KimResponsibilityInfo>	lookupResponsibilityInfo(Map<String,String> searchCriteria, boolean unbounded) Lookup responsibility objects.

Method Detail

getResponsibility

KimResponsibilityInfo getResponsibility(String responsibilityId)

Get the responsibility object with the given ID.

getResponsibilitiesByName

List<KimResponsibilityInfo> getResponsibilitiesByName(String namespaceCode,
                                                      String responsibilityName)

Return the responsibility object for the given unique combination of namespace, component and responsibility name.

getResponsibilityTemplate

KimResponsibilityTemplateInfo getResponsibilityTemplate(String responsibilityTemplateId)

getResponsibilityTemplateByName

KimResponsibilityTemplateInfo getResponsibilityTemplateByName(String namespaceCode,
                                                              String responsibilityTemplateName)

hasResponsibility

boolean hasResponsibility(String principalId,
                          String namespaceCode,
                          String responsibilityName,
                          AttributeSet qualification,
                          AttributeSet responsibilityDetails)

Check whether the principal has the given responsibility within the passed qualifier.

hasResponsibilityByTemplateName

boolean hasResponsibilityByTemplateName(String principalId,
                                        String namespaceCode,
                                        String responsibilityTemplateName,
                                        AttributeSet qualification,
                                        AttributeSet responsibilityDetails)

Check whether the principal has the given responsibility within the passed qualifier.

getResponsibilityActions

List<ResponsibilityActionInfo> getResponsibilityActions(String namespaceCode,
                                                        String responsibilityName,
                                                        AttributeSet qualification,
                                                        AttributeSet responsibilityDetails)

getResponsibilityActionsByTemplateName

List<ResponsibilityActionInfo> getResponsibilityActionsByTemplateName(String namespaceCode,
                                                                      String responsibilityTemplateName,
                                                                      AttributeSet qualification,
                                                                      AttributeSet responsibilityDetails)

areActionsAtAssignmentLevelById

boolean areActionsAtAssignmentLevelById(String responsibilityId)

Lets the system know (mainly for UI purposes) whether this responsibility expects RoleResponsibilityAction records to be given at the assignment level or are global to the responsibility. (I.e., they apply to any member assigned to the responsibility.)

areActionsAtAssignmentLevel

boolean areActionsAtAssignmentLevel(KimResponsibilityInfo responsibility)

Lets the system know (mainly for UI purposes) whether this responsibility expects RoleResponsibilityAction records to be given at the assignment level or are global to the responsibility. (I.e., they apply to any member assigned to the responsibility.)

lookupResponsibilityInfo

List<? extends KimResponsibilityInfo> lookupResponsibilityInfo(Map<String,String> searchCriteria,
                                                               boolean unbounded)

Lookup responsibility objects.

getRoleIdsForResponsibility

List<String> getRoleIdsForResponsibility(KimResponsibilityInfo responsibility,
                                         AttributeSet qualification)

Get the role IDs associated with the given responsibility.