public interface ICaseActivityService
Modifier and Type | Field and Description |
---|---|
static int |
MAX_RATING
Maximum rating for case activity
|
static int |
MIN_RATING
Minimum rating for case activity
|
Modifier and Type | Method and Description |
---|---|
boolean |
addWorkItem(IBPMContext context, CaseIdentifier caseIdentifier, java.lang.String caseActivityDefinitionId)
Make any unavailable activity available in library.
|
java.util.List<CaseActivityDefinition> |
getActivatableCaseActivities(IBPMContext context, CaseIdentifier caseIdentifier)
Deprecated.
|
java.util.List<CaseActivityDefinition> |
getCaseActivities(IBPMContext context, CaseIdentifier caseIdentifier, ICaseConstants.ActivityFilterType filter, java.lang.String orderBy, ICaseConstants.ActivitySortOrder sortOrder, java.util.List<ICaseConstants.ActivityOptionalInfo> optionalInfo, java.lang.String additionalJPQLWhereClause)
Get the list of available, unavailable, running, completed or faulted 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 |
markActivityRelevance(IBPMContext context, CaseIdentifier caseIdentifier, java.lang.String caseActivityDefinitionId, ICaseConstants.ActivityRelevance relevance)
Mark relevance of a case activity for a particular instance of a case
|
void |
rateActivityDefinition(IBPMContext context, java.lang.String caseActivityDefinitionId, int rating)
Deprecated.
|
void |
rateActivityInstance(IBPMContext context, CaseIdentifier caseIdentifier, java.lang.String caseActivityDefinitionId, int rating)
Deprecated.
|
void |
registerCaseActivity(IBPMContext context, CaseActivity caseActivity)
Register a case activity
|
void |
unregisterCaseActivity(IBPMContext context, java.lang.String caseActivityDefinitionId)
Unregister a case activity
|
static final int MAX_RATING
static final int MIN_RATING
@Deprecated java.util.List<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
valueList<CaseActivityDefinition>
valueCaseServiceException
- if an error occursjava.util.List<CaseActivityDefinition> getCaseActivities(IBPMContext context, CaseIdentifier caseIdentifier, ICaseConstants.ActivityFilterType filter, java.lang.String orderBy, ICaseConstants.ActivitySortOrder sortOrder, java.util.List<ICaseConstants.ActivityOptionalInfo> optionalInfo, java.lang.String additionalJPQLWhereClause) throws CaseServiceException
import java.util.List;
import oracle.bpm.casemgmt.caseactivity.model.CaseActivityDefinition;
import oracle.bpm.casemgmt.persistence.model.ICaseConstants;
import oracle.bpm.casemgmt.persistence.model.ICaseConstants.ActivitySortOrder;
import oracle.bpm.casemgmt.persistence.model.ICaseConstants.ActivitySortColumn;
import oracle.bpm.casemgmt.persistence.model.ICaseConstants.ActivityFilterType;
import oracle.bpm.casemgmt.persistence.model.ICaseConstants.ActivityOptionalInfo;
ICaseService caseService = ..;
IBPMContext context = ..;
CaseIdentifier caseIdentifier = ..;
// AVAILABLE activities sorted by instance rating in descending order
List<CaseActivityDefinition> activities = caseService.getCaseActivities(context, caseIdentifier,
ActivityFilterType.AVAILABLE,
ActivitySortColumn.INSTANCE_RATING.toString(),
ActivitySortOrder.DESCENDING, null, null);
//UNAVAILABLE activities sorted using JPQL order by for activity name in descending order.
String orderBy = "activityDefinition.name DESC";
List<ActivityOptionalInfo> optionalInfo = new ArrayList<ActivityOptionalInfo>();
//get process or task documentation.
optionalInfo.add(ActivityOptionalInfo.DOCUMENTATION);
//get human task assignees. Only for human task based activities and this works only for filter RUNNING, COMPLETED, FAULTED
optionalInfo.add(ActivityOptionalInfo.ASSIGNEES);
List<CaseActivityDefinition> activities = caseService.getCaseActivities(context, caseIdentifier,
ActivityFilterType.UNAVAILABLE,
orderBy,
null, optionalInfo, null);
//To get RUNNING activities ordered by started_date
orderBy = "caseEvent.started_date";
List<CaseActivityDefinition> activities = caseService.getCaseActivities(context, caseIdentifier,
ActivityFilterType.RUNNING,
orderBy,
null, optionalInfo, null);
//To get COMPLETED required activities
String additionalJPQLWhereClause = "activityDefinition.isRequired = 'Y'";
List<CaseActivityDefinition> activities = caseService.getCaseActivities(context, caseIdentifier,
ActivityFilterType.COMPLETED,
null,
null, null, additionalJPQLWhereClause);
* for (CaseActivityDefinition activity:activities) {
String definitionId = activity.getDefinitionId();
String displayName = activity.getDisplayName();
String required = activity.getIsRequired();
String isRepeatable = activity.getIsRepeatable();
int rating = activity.getInstanceRating();
List<DocumentationType> documentations = activity.getDocumentations();
List<DocumentationType> usecaseDocumentations = activity.getUseCaseDocumentations();
String state = activity.getState();
TaskInfo taskInfo = activity.getTaskInfo(); // For running, completed, faulted human task activities.
}
context
- an IBPMContext
valuecaseIdentifier
- a CaseIdentifier
valuefilter
- a ICaseConstants.ActivityFilterType
valueorderBy
- JPQL order by or a ICaseConstants.ActivitySortColumn
valuesortOrder
- a ICaseConstants.ActivitySortOrder
valueoptionalInfo
- a List<ICaseConstants.ActivityOptionalInfo>
valueadditionalJPQLWhereClause
- a String
valueList<CaseActivityDefinition>
valueCaseServiceException
- 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<String, Object>
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
valueboolean
valueCaseServiceException
- if an error occursvoid registerCaseActivity(IBPMContext context, CaseActivity caseActivity) throws CaseServiceException
context
- an IBPMContext
valuecaseActivity
- a CaseActivity
valueCaseServiceException
- if an error occursvoid unregisterCaseActivity(IBPMContext context, java.lang.String caseActivityDefinitionId) throws CaseServiceException
context
- an IBPMContext
valuecaseActivityDefinitionId
- a String
valueCaseServiceException
- if an error occurs@Deprecated void 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 occurs@Deprecated void 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 occursboolean addWorkItem(IBPMContext context, CaseIdentifier caseIdentifier, java.lang.String caseActivityDefinitionId) throws CaseServiceException
context
- an IBPMContext
valuecaseIdentifier
- a CaseIdentifier
valuecaseActivityDefinitionId
- a String
value. This is the same as CaseActivityDefinition.getDefinitionIdboolean
valueCaseServiceException
- if an error occursvoid markActivityRelevance(IBPMContext context, CaseIdentifier caseIdentifier, java.lang.String caseActivityDefinitionId, ICaseConstants.ActivityRelevance relevance) throws CaseServiceException
context
- an IBPMContext
valuecaseIdentifier
- a CaseIdentifier
valuecaseActivityDefinitionId
- a String
valuerelevance
- an ICaseConstants.ActivityRelevance
value. To represent no relevance associated to the activity , use NONE.CaseServiceException
- if an error occurs