|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.7.0) E25378-07 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
static final int MAX_RATING
static final int MIN_RATING
Method Detail |
---|
java.util.List<oracle.bpm.casemgmt.caseactivity.model.CaseActivityDefinition> getActivatableCaseActivities(IBPMContext context, CaseIdentifier caseIdentifier) throws CaseServiceException
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();
}
context
- an IBPMContext
valuecaseIdentifier
- a CaseIdentifier
value
List
value
CaseServiceException
- if an error occursboolean initiateCaseActivity(IBPMContext context, CaseIdentifier caseIdentifier, java.lang.String caseActivityDefinitionId, java.util.Map<java.lang.String,java.lang.Object> payload, Comment comment) throws CaseServiceException
context
- an IBPMContext
valuecaseIdentifier
- a CaseIdentifier
valuecaseActivityDefinitionId
- a String
value. This is the same as CaseActivityDefinition.getDefinitionIdpayload
- 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 Nodecomment
- a Comment
value
boolean
value
CaseServiceException
- if an error occursvoid registerCaseActivity(IBPMContext context, CaseActivity caseActivity) throws CaseServiceException
context
- an IBPMContext
valuecaseActivity
- a CaseActivity
value
CaseServiceException
- if an error occursvoid rateActivityDefinition(IBPMContext context, java.lang.String caseActivityDefinitionId, int rating) throws CaseServiceException
context
- an IBPMContext
valuecaseActivityDefinitionId
- a String
value. This is the same as CaseActivityDefinition.getDefinitionIdrating
- an int
value. Expected to be between 1 and 5. -1 indicates no rating available.
CaseServiceException
- if an error occursvoid rateActivityInstance(IBPMContext context, CaseIdentifier caseIdentifier, java.lang.String caseActivityDefinitionId, int rating) throws CaseServiceException
context
- an IBPMContext
valuecaseIdentifier
- a CaseIdentifier
valuecaseActivityDefinitionId
- a String
valuerating
- an int
value. Expected to be between 1 and 5. -1 indicates no rating available.
CaseServiceException
- if an error occurs
|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.7.0) E25378-07 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |