ResponsibilityService

Name Responsibility
Version
Included Services  
Java Package org.kuali.rice.kim.api.responsibility

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


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.

Operations
Main Message Structures

Method createResponsibility
Description This will create a {@link Responsibility} exactly like the responsibility passed in.
Parameters Responsibility responsibility the responsibility to create
Return Responsibility the id of the newly created object. will never be null.
Errors RiceIllegalArgumentException if the responsibility is null
RiceIllegalStateException if the responsibility is already existing in the system

Back to Operations

Method updateResponsibility
Description This will up ev a {@link Responsibility}.
Parameters Responsibility responsibility the responsibility to update
Return Responsibility ???
Errors RiceIllegalArgumentException if the responsibility is null
RiceIllegalStateException if the responsibility does not exist in the system

Back to Operations

Method getResponsibility
Description Gets a {@link Responsibility} from an id.


This method will return null if the responsibility does not exist.
Parameters String id the unique id to retrieve the responsibility by. cannot be null or blank.
Return Responsibility a {@link Responsibility} or null
Errors RiceIllegalArgumentException if the id is null or blank

Back to Operations

Method findRespByNamespaceCodeAndName
Description Finds a {@link Responsibility} for namespaceCode and name.
Parameters String namespaceCode the namespace code. cannot be null or blank.
String name the responsibility name. cannot be null or blank.
Return Responsibility a {@link Responsibility} or null
Errors RiceIllegalArgumentException if the id or namespaceCode is null or blank

Back to Operations

Method getResponsibilityTemplate
Description Gets a {@link Template} from an id.


This method will return null if the template does not exist.
Parameters String id the unique id to retrieve the template by. cannot be null or blank.
Return Template a {@link Template} or null
Errors RiceIllegalArgumentException if the id is null or blank

Back to Operations

Method findRespTemplateByNamespaceCodeAndName
Description Finds a {@link Template} for namespaceCode and name.
Parameters String namespaceCode the namespace code. cannot be null or blank.
String name the template name. cannot be null or blank.
Return Template a {@link Template} or null
Errors RiceIllegalArgumentException if the id or namespaceCode is null or blank

Back to Operations

Method hasResponsibility
Description Checks in a given principal id has a responsibility using the passed in responsibility information.
Parameters String principalId the principal id to check. cannot be null or blank.
String namespaceCode the namespace code. cannot be null or blank.
String respName the responsibility name. cannot be null or blank.
Map qualification the qualification for the responsibility. cannot be null.
Return boolean true is principal has responsibility
Errors RiceIllegalArgumentException if the principalId, namespaceCode, respName is null or blank

Back to Operations

Method hasResponsibilityByTemplate
Description Checks in a given principal id has a responsibility using the passed in responsibility template information.
Parameters String principalId the principal id to check. cannot be null or blank.
String namespaceCode the namespace code. cannot be null or blank.
String respTemplateName the responsibility template name. cannot be null or blank.
Map qualification the qualification for the responsibility. cannot be null.
Map respDetails the responsibility details. cannot be null.
Return boolean true is principal has responsibility
Errors RiceIllegalArgumentException if the principalId, namespaceCode, respName is null or blank

Back to Operations

Method getResponsibilityActions
Description Gets a List of {@link ResponsibilityAction} based on passed in responsibility information.
Parameters String namespaceCode the namespace code. cannot be null or blank.
String respName the responsibility name. cannot be null or blank.
Map qualification the qualification for the responsibility. cannot be null.
Return ResponsibilityActionList an immutable list of ResponsibilityAction. Will not return null.
Errors RiceIllegalArgumentException if the namespaceCode, respName is null or blank

Back to Operations

Method getResponsibilityActionsByTemplate
Description Gets a List of {@link ResponsibilityAction} based on passed in responsibility template information.
Parameters String namespaceCode the namespace code. cannot be null or blank.
String respTemplateName the responsibility name. cannot be null or blank.
Map qualification the qualification for the responsibility. cannot be null.
Map respDetails the responsibility details. can be null.
Return ResponsibilityActionList an immutable list of ResponsibilityAction. Will not return null.
Errors RiceIllegalArgumentException if the namespaceCode, respName is null or blank

Back to Operations

Method getRoleIdsForResponsibility
Description Gets a List of roleIds that the responsibility is associated with.
Parameters String id the unique id to retrieve the roleIds for. cannot be null or blank.
Return StringList an immutable list of roleIds. Will not return null.
Errors RiceIllegalArgumentException if the id is null or blank or if the qualification is null

Back to Operations

Method findResponsibilities
Description This method find Responsibilities based on a query criteria. The criteria cannot be null.
Parameters QueryByCriteria queryByCriteria the criteria. Cannot be null.
Return ResponsibilityQueryResults query results. will never return null.
Errors RiceIllegalArgumentException if the queryByCriteria is null

Back to Operations

Method findResponsibilityTemplates
Description This method find Responsibility Templates based on a query criteria. The criteria cannot be null.
Parameters QueryByCriteria queryByCriteria the criteria. Cannot be null.
Return TemplateQueryResults query results. will never return null.
Errors RiceIllegalArgumentException if the queryByCriteria is null

Back to Operations

Method findResponsibilitiesByTemplate
Description Return the responsibilities for the given unique combination of namespace,
and responsibility template name.
Parameters String namespaceCode namespace code for permission. cannot be null or blank.
String templateName name of permission template. cannot be null or blank.
Return ResponsibilityList a list of {@link org.kuali.rice.kim.api.permission.Permission} or null
Errors RiceIllegalArgumentException if the namespaceCode or name is null or blank

Back to Operations