oracle.bpm.casemgmt
Interface ICaseActivityService

All Known Subinterfaces:

ICaseService

public interface ICaseActivityService

This interface defined all APIs related to case activities

Field Summary

static int	MAX_RATING Maximum rating for case activity
static int	MIN_RATING Minimum rating for case activity

Method Summary

java.util.List<oracle.bpm.casemgmt.caseactivity.model.CaseActivityDefinition>	getActivatableCaseActivities(IBPMContext context, CaseIdentifier caseIdentifier) Get the list of activatable case activities
boolean	initiateCaseActivity(IBPMContext context, CaseIdentifier caseIdentifier, java.lang.String caseActivityDefinitionId, java.util.Map<java.lang.String,java.lang.Object> payload, Comment comment) Initiate a case activity.
void	rateActivityDefinition(IBPMContext context, java.lang.String caseActivityDefinitionId, int rating) Rate a case activity.
void	rateActivityInstance(IBPMContext context, CaseIdentifier caseIdentifier, java.lang.String caseActivityDefinitionId, int rating) Rate a case activity for a particular instance of a case
void	registerCaseActivity(IBPMContext context, CaseActivity caseActivity) Register a case activity

Field Detail

MAX_RATING

static final int MAX_RATING

Maximum rating for case activity

See Also:

Constant Field Values

MIN_RATING

static final int MIN_RATING

Minimum rating for case activity

See Also:

Constant Field Values

Method Detail

getActivatableCaseActivities

java.util.List<oracle.bpm.casemgmt.caseactivity.model.CaseActivityDefinition> getActivatableCaseActivities(IBPMContext context,
                                                                                                           CaseIdentifier caseIdentifier)
                                                                                                           throws CaseServiceException

Get the list of activatable case activities

 IBPMContext context  = ..;
 CaseIdentifier caseIdentifier  = ..;
 ICaseService caseService = ..;
 List<CaseActivityDefinition> activities = caseService.getActivatableCaseActivities(context, caseIdentifier);

 for (CaseActivityDefinition activity:activities) {
      String definitionId = activity.getDefinitionId();
      String displayName = activity.getDisplayName();
      String required = activity.getIsRequired();
      String isRepeatable = activity.getIsRepeatable();
      int rating = activity.getInstanceRating();
 }

 
 

Parameters:

context - an IBPMContext value

caseIdentifier - a CaseIdentifier value

Returns:

a List value

Throws:

CaseServiceException - if an error occurs

initiateCaseActivity

boolean initiateCaseActivity(IBPMContext context,
                             CaseIdentifier caseIdentifier,
                             java.lang.String caseActivityDefinitionId,
                             java.util.Map<java.lang.String,java.lang.Object> payload,
                             Comment comment)
                             throws CaseServiceException

Initiate a case activity.

Parameters:

context - an IBPMContext value

caseIdentifier - a CaseIdentifier value

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

payload - a Map value. This information is optional. For case activities that map case data to data initiating case activity, this is not needed. When there are case activities which require use to provide data for initiation, this data is required. For initiating activities that are implemented using BPMN or Human Task, the type of Object is expected to be an XML Node

comment - a Comment value

Returns:

a boolean value

Throws:

CaseServiceException - if an error occurs

registerCaseActivity

void registerCaseActivity(IBPMContext context,
                          CaseActivity caseActivity)
                          throws CaseServiceException

Register a case activity

Parameters:

context - an IBPMContext value

caseActivity - a CaseActivity value

Throws:

CaseServiceException - if an error occurs

rateActivityDefinition

void rateActivityDefinition(IBPMContext context,
                            java.lang.String caseActivityDefinitionId,
                            int rating)
                            throws CaseServiceException

Rate a case activity. This rating will apply to this case activity across all instances

Parameters:

context - an IBPMContext value

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

rating - an int value. Expected to be between 1 and 5. -1 indicates no rating available.

Throws:

CaseServiceException - if an error occurs

rateActivityInstance

void rateActivityInstance(IBPMContext context,
                          CaseIdentifier caseIdentifier,
                          java.lang.String caseActivityDefinitionId,
                          int rating)
                          throws CaseServiceException

Rate a case activity for a particular instance of a case

Parameters:

context - an IBPMContext value

caseIdentifier - a CaseIdentifier value

caseActivityDefinitionId - a String value

rating - an int value. Expected to be between 1 and 5. -1 indicates no rating available.

Throws:

CaseServiceException - if an error occurs