ICasePermissionService (Oracle Fusion Middleware BPM-Services Java API Reference for Oracle BPM Suite)

All Known Subinterfaces:

ICaseService
```
public interface ICasePermissionService
```
Defines APIs related to permission management for case

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`checkCaseTagPermission(IBPMContext ctx, CaseIdentifier caseId, java.lang.String permissionTag, ICaseConstants.CaseObjectPermissionType action, ICaseConstants.CaseObjectType caseObjectType)` Check if the user represented by ctx, has permission to perform 'Action' on case Objects with case permission tag PUBLIC.COMMENTS.WRITE.Role
`java.util.Set<ICaseConstants.CaseObjectPermissionType>`	`getActionsUserCanPerform(IBPMContext ctx, CaseIdentifier caseId, ICaseConstants.CaseObjectType caseObjectType)` Get the list of actions the user can perfom in this case for given case object type.
`java.util.Set<ICaseConstants.CaseObjectPermissionType>`	`getActionsUserCanPerformOnCaseObject(IBPMContext ctx, CaseIdentifier caseId, CaseObject caseObj)` Returns a list of actions user can perform on the given case Object.
`java.util.Set<java.lang.String>`	`getPermissionTags(IBPMContext ctx, CaseIdentifier caseId)` Returns a list of available Permission Tags.
`java.util.Set<java.lang.String>`	`getPermissionTagsUserCanUse(IBPMContext ctx, CaseIdentifier caseId, ICaseConstants.CaseObjectPermissionType action, ICaseConstants.CaseObjectType caseObjectType)` Returns a list of permission tags the user is authorized to use for the given case object type.
`boolean`	`setCaseActivityPermissionTag(IBPMContext context, CaseIdentifier caseIdentifier, java.lang.String caseActivityDefinitionId, java.lang.String permissionTag)` Update the permission tag on case activity.
`boolean`	`setPermissionTag(IBPMContext context, CaseIdentifier caseIdentifier, CaseObject caseObject, java.lang.String permissionTag)` To set Permission tag on a Case Object, user should have permission to "UPDATE" action on that case Object.

Method Detail

getPermissionTags

java.util.Set<java.lang.String> getPermissionTags(IBPMContext ctx,
                                                  CaseIdentifier caseId)
                                           throws CaseServiceException

Returns a list of available Permission Tags.

Parameters:: ctx - an IBPMContext value; caseId - a CaseIdentifier value
Returns:: a Set<String> value
Throws:: CaseServiceException - if an error occurs

getPermissionTagsUserCanUse

java.util.Set<java.lang.String> getPermissionTagsUserCanUse(IBPMContext ctx,
                                                            CaseIdentifier caseId,
                                                            ICaseConstants.CaseObjectPermissionType action,
                                                            ICaseConstants.CaseObjectType caseObjectType)
                                                     throws CaseServiceException

Returns a list of permission tags the user is authorized to use for the given case object type.

Throws:: CaseServiceException

getActionsUserCanPerform

java.util.Set<ICaseConstants.CaseObjectPermissionType> getActionsUserCanPerform(IBPMContext ctx,
                                                                                CaseIdentifier caseId,
                                                                                ICaseConstants.CaseObjectType caseObjectType)
                                                                         throws CaseServiceException

Get the list of actions the user can perfom in this case for given case object type.

Parameters:: ctx - an IBPMContext value; caseId - a CaseIdentifier value; caseObjectType - a ICaseConstants.CaseObjectType value
Returns:: a Set<ICaseConstants.CaseObjectPermissionType> value
Throws:: CaseServiceException - if an error occurs

getActionsUserCanPerformOnCaseObject

java.util.Set<ICaseConstants.CaseObjectPermissionType> getActionsUserCanPerformOnCaseObject(IBPMContext ctx,
                                                                                            CaseIdentifier caseId,
                                                                                            CaseObject caseObj)
                                                                                     throws CaseServiceException

Returns a list of actions user can perform on the given case Object.

Throws:: CaseServiceException

checkCaseTagPermission

boolean checkCaseTagPermission(IBPMContext ctx,
                               CaseIdentifier caseId,
                               java.lang.String permissionTag,
                               ICaseConstants.CaseObjectPermissionType action,
                               ICaseConstants.CaseObjectType caseObjectType)
                        throws CaseServiceException

Check if the user represented by ctx, has permission to perform 'Action' on case Objects with case permission tag PUBLIC.COMMENTS.WRITE.Role

Parameters:: ctx - an IBPMContext value; caseId - a CaseIdentifier value; permissionTag - a String value; action - a ICaseConstants.CaseObjectPermissionType value; caseObjectType - a ICaseConstants.CaseObjectType value
Returns:: a boolean value
Throws:: CaseServiceException - if an error occurs

setPermissionTag
```
boolean setPermissionTag(IBPMContext context,
                         CaseIdentifier caseIdentifier,
                         CaseObject caseObject,
                         java.lang.String permissionTag)
                  throws CaseServiceException
```
To set Permission tag on a Case Object, user should have permission to "UPDATE" action on that case Object. For a event case object however user must have permission to "UPDATE" action on "HEADER". To set permission tag on a activity use setCaseActivityPermissionTag() Api instead.

Parameters:

context - an IBPMContext value

caseIdentifier - a CaseIdentifier value

caseObject - a CaseObject value

permissionTag - a String value

Returns:

a boolean value

Throws:

CaseServiceException - if an error occurs

setCaseActivityPermissionTag
```
boolean setCaseActivityPermissionTag(IBPMContext context,
                                     CaseIdentifier caseIdentifier,
                                     java.lang.String caseActivityDefinitionId,
                                     java.lang.String permissionTag)
                              throws CaseServiceException
```
Update the permission tag on case activity. This permission tag applies to all activities defined by caseActivityDefinitionId.

Parameters:

context - an IBPMContext value

caseIdentifier - a CaseIdentifier value

caseActivityDefinitionId - a String value. This is the same as CaseActivityDefinition.getDefinitionId

tag - a String value

Throws:

CaseServiceException - if an error occurs

Interface ICasePermissionService