public interface CaseService
Modifier and Type | Method and Description |
---|---|
String |
addCaseComment(String caseId,
String author,
String comment,
String... restrictedTo)
Adds new comment to the case
|
void |
addDataToCaseFile(String caseId,
Map<String,Object> data,
String... restrictedTo)
Adds complete map to case file of given case.
|
void |
addDataToCaseFile(String caseId,
String name,
Object value,
String... restrictedTo)
Adds given named value into case file of given case.
|
Long |
addDynamicSubprocess(Long processInstanceId,
String processId,
Map<String,Object> parameters)
Adds new subprocess (identified by process id) to case.
|
Long |
addDynamicSubprocess(String caseId,
String processId,
Map<String,Object> parameters)
Adds new subprocess (identified by process id) to given process instance.
|
Long |
addDynamicSubprocessToStage(Long processInstanceId,
String stage,
String processId,
Map<String,Object> parameters)
Adds new subprocess (identified by process id) to case.
|
Long |
addDynamicSubprocessToStage(String caseId,
String stage,
String processId,
Map<String,Object> parameters)
Adds new subprocess (identified by process id) to given process instance.
|
void |
addDynamicTask(Long processInstanceId,
TaskSpecification taskSpecification)
Adds new user task to specified process instance.
|
void |
addDynamicTask(String caseId,
TaskSpecification taskSpecification)
Adds new user task to specified case.
|
void |
addDynamicTaskToStage(Long processInstanceId,
String stage,
TaskSpecification taskSpecification)
Adds new user task to specified case and stage on given process instance.
|
void |
addDynamicTaskToStage(String caseId,
String stage,
TaskSpecification taskSpecification)
Adds new user task to specified case and stage.
|
void |
assignToCaseRole(String caseId,
String role,
org.kie.api.task.model.OrganizationalEntity entity)
Assigns given entity (user or group) to case role for a given case.
|
void |
cancelCase(String caseId)
Cancels case with given case id (including all attached process instances if any).
|
void |
closeCase(String caseId,
String comment)
Closes case with given case id (including all attached process instances if any).
|
void |
destroyCase(String caseId)
Permanently destroys case identified by given case id.
|
Collection<CommentInstance> |
getCaseComments(String caseId,
CommentSortBy sortBy,
org.kie.api.runtime.query.QueryContext queryContext)
Returns all case comments sorted with given sortBy
|
Collection<CommentInstance> |
getCaseComments(String caseId,
org.kie.api.runtime.query.QueryContext queryContext)
Returns all case comments sorted by date
|
CaseFileInstance |
getCaseFileInstance(String caseId)
Returns Case file for give case id
|
CaseInstance |
getCaseInstance(String caseId)
Returns case instance (only if it's active) identified by given case id - does not load case file, roles, milestones nor stages.
|
CaseInstance |
getCaseInstance(String caseId,
boolean withData,
boolean withRoles,
boolean withMilestones,
boolean withStages)
Returns case instance (only if it's active) identified by given case id with options on what should be fetched
|
Collection<CaseRoleInstance> |
getCaseRoleAssignments(String caseId)
Returns role assignments for given case
|
CaseFileInstance |
newCaseFileInstance(String deploymentId,
String caseDefinition,
Map<String,Object> data)
Builds and returns new CaseFileInstance with given data.
|
CaseFileInstance |
newCaseFileInstance(String deploymentId,
String caseDefinition,
Map<String,Object> data,
Map<String,org.kie.api.task.model.OrganizationalEntity> rolesAssignment)
Builds and returns new CaseFileInstance with given data and roles assignments.
|
CaseFileInstance |
newCaseFileInstanceWithRestrictions(String deploymentId,
String caseDefinition,
Map<String,Object> data,
Map<String,List<String>> accessRestrictions)
Builds and returns new CaseFileInstance with given data.
|
CaseFileInstance |
newCaseFileInstanceWithRestrictions(String deploymentId,
String caseDefinition,
Map<String,Object> data,
Map<String,org.kie.api.task.model.OrganizationalEntity> rolesAssignment,
Map<String,List<String>> accessRestrictions)
Builds and returns new CaseFileInstance with given data and roles assignments.
|
org.kie.api.task.model.Group |
newGroup(String groupId)
Creates new group with given id;
|
TaskSpecification |
newHumanTaskSpec(String taskName,
String description,
String actorIds,
String groupIds,
Map<String,Object> parameters)
Returns new TaskSpecification describing user task so it can be created as dynamic task.
|
TaskSpecification |
newTaskSpec(String nodeType,
String nodeName,
Map<String,Object> parameters)
Returns new TaskSpecification describing generic (work item based) task so it can be added as dynamic task.
|
org.kie.api.task.model.User |
newUser(String userId)
Creates new user with given id;
|
void |
removeCaseComment(String caseId,
String commentId)
Removes given comment from the case comments list
|
void |
removeDataFromCaseFile(String caseId,
List<String> variableNames)
Removes given variables (stored under variableNames) from case file of given case.
|
void |
removeDataFromCaseFile(String caseId,
String name)
Removes given variable (stored under name) from case file of given case.
|
void |
removeFromCaseRole(String caseId,
String role,
org.kie.api.task.model.OrganizationalEntity entity)
Removes given entity (user or group) from the case role for a given case.
|
void |
reopenCase(String caseId,
String deploymentId,
String caseDefinitionId)
Reopens case given by case id by starting another instance of case definition.
|
void |
reopenCase(String caseId,
String deploymentId,
String caseDefinitionId,
Map<String,Object> data)
Reopens case given by case id by starting another instance of case definition.
|
String |
startCase(String deploymentId,
String caseDefinitionId)
Starts a new case for given definition with empty case file.
|
String |
startCase(String deploymentId,
String caseDefinitionId,
CaseFileInstance caseFile)
Starts a new case for given definition with given case file.
|
void |
triggerAdHocFragment(Long processInstanceId,
String fragmentName,
Object data)
Triggers given by fragmentName adhoc element (such as task, milestone) within given process instance
|
void |
triggerAdHocFragment(Long processInstanceId,
String stage,
String fragmentName,
Object data)
Triggers given by fragmentName adhoc element (such as task, milestone) within given process instance and stage
|
void |
triggerAdHocFragment(String caseId,
String fragmentName,
Object data)
Triggers given by fragmentName adhoc element (such as task, milestone) within given case.
|
void |
triggerAdHocFragment(String caseId,
String stage,
String fragmentName,
Object data)
Triggers given by fragmentName adhoc element (such as task, milestone) within given case and stage.
|
void |
updateCaseComment(String caseId,
String commentId,
String author,
String text,
String... restrictedTo)
Updated given comment with entire text provided
|
String startCase(String deploymentId, String caseDefinitionId)
CASE-XXXXXXXXX
where XXXXXXX
is generated value for the prefixdeploymentId
- deployment id of project that case definition belongs tocaseDefinitionId
- id of case definitionString startCase(String deploymentId, String caseDefinitionId, CaseFileInstance caseFile)
CASE-XXXXXXXXX
where XXXXXXX
is generated value for the prefixdeploymentId
- deployment id of project that case definition belongs tocaseDefinitionId
- id of case definitioncaseFile
- initial case file to be used for this caseCaseFileInstance getCaseFileInstance(String caseId) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodCaseNotFoundException
- thrown in case case was not found with given idCaseInstance getCaseInstance(String caseId) throws CaseNotFoundException
getCaseInstance(String, boolean, boolean, boolean, boolean)
for more advanced fetch options.caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodCaseNotFoundException
- thrown in case case was not found with given idCaseInstance getCaseInstance(String caseId, boolean withData, boolean withRoles, boolean withMilestones, boolean withStages) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodwithData
- determines if case file should be loadedwithRoles
- determines if role assignments should be loadedwithMilestones
- determines if milestones should be loadedwithStages
- determines with stages should be loadedCaseNotFoundException
- thrown in case case was not found with given idvoid closeCase(String caseId, String comment) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodoptional
- comment to be added when closing the case instanceCaseNotFoundException
- thrown in case case was not found with given idvoid cancelCase(String caseId) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodCaseNotFoundException
- thrown in case case was not found with given idvoid destroyCase(String caseId) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodCaseNotFoundException
- thrown in case case was not found with given idvoid reopenCase(String caseId, String deploymentId, String caseDefinitionId) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methoddeploymentId
- deployment id of project that case definition belongs tocaseDefinitionId
- id of case definitionCaseNotFoundException
- thrown in case case was not found with given idCaseActiveException
- thrown when case is still activevoid reopenCase(String caseId, String deploymentId, String caseDefinitionId, Map<String,Object> data) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methoddeploymentId
- deployment id of project that case definition belongs tocaseDefinitionId
- id of case definitiondata
- additional data to be set on case fileCaseNotFoundException
- thrown in case case was not found with given idCaseActiveException
- thrown when case is still activevoid addDynamicTask(String caseId, TaskSpecification taskSpecification) throws CaseNotFoundException
addDynamicTask(Long, TaskSpecification)
should be usedcaseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodtaskSpecification
- complete specification that defines the type of a task to be addedCaseNotFoundException
- thrown in case case was not found with given idvoid addDynamicTask(Long processInstanceId, TaskSpecification taskSpecification) throws org.jbpm.services.api.ProcessInstanceNotFoundException
processInstanceId
- unique process instance idtaskSpecification
- complete specification that defines the type of a task to be addedCaseNotFoundException
- thrown in case case was not found with given idorg.jbpm.services.api.ProcessInstanceNotFoundException
void addDynamicTaskToStage(String caseId, String stage, TaskSpecification taskSpecification) throws CaseNotFoundException, StageNotFoundException
addDynamicTaskToStage(Long, String, TaskSpecification)
should be usedcaseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodstage
- id or name of the stage there the task should be addedtaskSpecification
- complete specification that defines the type of a task to be addedCaseNotFoundException
- thrown in case case was not found with given idStageNotFoundException
- thrown in case stage does not existvoid addDynamicTaskToStage(Long processInstanceId, String stage, TaskSpecification taskSpecification) throws CaseNotFoundException, StageNotFoundException
processInstanceId
- unique process instance idstage
- id or name of the stage there the task should be addedtaskSpecification
- complete specification that defines the type of a task to be addedCaseNotFoundException
- thrown in case case was not found with given idStageNotFoundException
- thrown in case stage does not existLong addDynamicSubprocess(String caseId, String processId, Map<String,Object> parameters) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodprocessId
- identifier of the process to be addedparameters
- optional parameters for the subprocessCaseNotFoundException
- thrown in case case was not found with given idLong addDynamicSubprocess(Long processInstanceId, String processId, Map<String,Object> parameters) throws CaseNotFoundException
processInstanceId
- unique process instance idprocessId
- identifier of the process to be addedparameters
- optional parameters for the subprocessCaseNotFoundException
- thrown in case case was not found with given idLong addDynamicSubprocessToStage(String caseId, String stage, String processId, Map<String,Object> parameters) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase method addDynamicSubprocess(Long, String, Map)
method should be used instead.stage
- id or name of the stage there the task should be addedprocessId
- identifier of the process to be addedparameters
- optional parameters for the subprocessCaseNotFoundException
- thrown in case case was not found with given idLong addDynamicSubprocessToStage(Long processInstanceId, String stage, String processId, Map<String,Object> parameters) throws CaseNotFoundException
processInstanceId
- unique process instance idstage
- id or name of the stage there the task should be addedprocessId
- identifier of the process to be addedparameters
- optional parameters for the subprocessCaseNotFoundException
- thrown in case case was not found with given idvoid triggerAdHocFragment(String caseId, String fragmentName, Object data) throws CaseNotFoundException
triggerAdHocFragment(Long, String, Object)
method should be used insteadcaseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodfragmentName
- name of the element that can be triggereddata
- optional data to be given when triggering the nodeCaseNotFoundException
void triggerAdHocFragment(Long processInstanceId, String fragmentName, Object data) throws CaseNotFoundException
processInstanceId
- unique process instance idfragmentName
- name of the element that can be triggereddata
- optional data to be given when triggering the nodeCaseNotFoundException
- thrown in case case was not found with given idvoid triggerAdHocFragment(String caseId, String stage, String fragmentName, Object data) throws CaseNotFoundException
triggerAdHocFragment(Long, String, String, Object)
method should be used insteadcaseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodstage
- id or name of the stage there the task should be addedfragmentName
- name of the element that can be triggereddata
- optional data to be given when triggering the nodeCaseNotFoundException
void triggerAdHocFragment(Long processInstanceId, String stage, String fragmentName, Object data) throws CaseNotFoundException
processInstanceId
- unique process instance idstage
- id or name of the stage there the task should be addedfragmentName
- name of the element that can be triggereddata
- optional data to be given when triggering the nodeCaseNotFoundException
- thrown in case case was not found with given idvoid addDataToCaseFile(String caseId, String name, Object value, String... restrictedTo) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodname
- unique name for given value to be put into case filevalue
- actual value to be added to case filerestrictedTo
- optional case roles that this data should be restricted toCaseNotFoundException
- thrown in case case was not found with given idvoid addDataToCaseFile(String caseId, Map<String,Object> data, String... restrictedTo) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methoddata
- key value representing data to be added to case filerestrictedTo
- optional case roles that this data should be restricted toCaseNotFoundException
- thrown in case case was not found with given idvoid removeDataFromCaseFile(String caseId, String name) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodname
- variable name that should be removed from case fileCaseNotFoundException
- thrown in case case was not found with given idvoid removeDataFromCaseFile(String caseId, List<String> variableNames) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodvariableNames
- list of variables to be removed from the case fileCaseNotFoundException
- thrown in case case was not found with given idvoid assignToCaseRole(String caseId, String role, org.kie.api.task.model.OrganizationalEntity entity) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodrole
- name of the role entity should be assigned toentity
- user or group to be assigned to given roleCaseNotFoundException
- thrown in case case was not found with given idIllegalArgumentException
- thrown in case there no role found with given name or cardinality was exceededvoid removeFromCaseRole(String caseId, String role, org.kie.api.task.model.OrganizationalEntity entity) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodrole
- name of the role entity should be assigned toentity
- entity user or group to be assigned to given roleCaseNotFoundException
- thrown in case case was not found with given idCollection<CaseRoleInstance> getCaseRoleAssignments(String caseId) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodCaseNotFoundException
- thrown in case case was not found with given idCollection<CommentInstance> getCaseComments(String caseId, org.kie.api.runtime.query.QueryContext queryContext) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodCaseNotFoundException
- thrown in case case was not found with given idCollection<CommentInstance> getCaseComments(String caseId, CommentSortBy sortBy, org.kie.api.runtime.query.QueryContext queryContext) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodsortBy
- defines how to sort commentsCaseNotFoundException
- thrown in case case was not found with given idString addCaseComment(String caseId, String author, String comment, String... restrictedTo) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodauthor
- author of the commentcomment
- actual comment (text)restrictedTo
- optional case roles that this data should be restricted toCaseNotFoundException
- thrown in case case was not found with given idvoid updateCaseComment(String caseId, String commentId, String author, String text, String... restrictedTo) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodcommentId
- unique id of the commentauthor
- author of the commenttext
- updated text of the commentrestrictedTo
- optional case roles that this data should be restricted toCaseNotFoundException
- thrown in case case was not found with given idvoid removeCaseComment(String caseId, String commentId) throws CaseNotFoundException
caseId
- unique case id in the format PREFIX-GENERATED_ID as described on startCase methodcommentId
- unique id of the commentCaseNotFoundException
- thrown in case case was not found with given idCaseFileInstance newCaseFileInstance(String deploymentId, String caseDefinition, Map<String,Object> data)
deploymentId
- deployment that case belongs tocaseDefinition
- id of the case definition to be able to properly setup case filedata
- initial data for case fileCaseFileInstance newCaseFileInstanceWithRestrictions(String deploymentId, String caseDefinition, Map<String,Object> data, Map<String,List<String>> accessRestrictions)
deploymentId
- deployment that case belongs tocaseDefinition
- id of the case definition to be able to properly setup case filedata
- initial data for case fileaccessRestrictions
- access restrictions to data that defines what case roles are allowed to add and manipulate given dataCaseFileInstance newCaseFileInstance(String deploymentId, String caseDefinition, Map<String,Object> data, Map<String,org.kie.api.task.model.OrganizationalEntity> rolesAssignment)
deploymentId
- deployment that case belongs tocaseDefinition
- id of the case definition to be able to properly setup case filedata
- initial data for case filerolesAssignment
- initial role assignmentCaseFileInstance newCaseFileInstanceWithRestrictions(String deploymentId, String caseDefinition, Map<String,Object> data, Map<String,org.kie.api.task.model.OrganizationalEntity> rolesAssignment, Map<String,List<String>> accessRestrictions)
deploymentId
- deployment that case belongs tocaseDefinition
- id of the case definition to be able to properly setup case filedata
- initial data for case filerolesAssignment
- initial role assignmentaccessRestrictions
- access restrictions to data that defines what case roles are allowed to add and manipulate given dataTaskSpecification newHumanTaskSpec(String taskName, String description, String actorIds, String groupIds, Map<String,Object> parameters)
taskName
- - mandatory name of the taskdescription
- - optional description of the taskactorIds
- - optional list (comma separated) of actors to be assignedgroupIds
- - optional list (comma separated) of groups to be assignedparameters
- - optional parameters (task inputs)TaskSpecification newTaskSpec(String nodeType, String nodeName, Map<String,Object> parameters)
nodeType
- - type of a node (same as used for registering work item handler)nodeName
- - name of the node to be assigned on taskparameters
- - optional parameters (task inputs)org.kie.api.task.model.User newUser(String userId)
userId
- user id to be used when creating User instanceorg.kie.api.task.model.Group newGroup(String groupId)
groupId
- group id to be used when creating Group instanceCopyright © 2001–2019 JBoss by Red Hat. All rights reserved.