Interface WorkflowEngine
-
- All Known Implementing Classes:
WorkflowEngineImpl
public interface WorkflowEngine
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
checkRequiredFieldsForTransition(WorkflowTransition transition)
Checks whether the required fields must be filled in to complete the specified transition..void
forceInvokeAutoTransition(WorkflowableTask task, WorkflowTransition transition)
Performing an automatic transition for a given task without checking its capability.TransitionResult
forceInvokeAutoTransitionIgnorePostFunctions(WorkflowTransition transition, WorkflowableTask task)
Performing an automatic transition for a specified task without executing post functions and checking its capability.void
forceInvokeAutoTransitionToHiddenStep(WorkflowableTask task)
Performing an automatic transition for a specified task to a step with the HIDDEN status, if it exists in the transition model.org.springframework.data.jpa.domain.Specification<User>
getAssigneeRecommendationSpecification(WorkflowableTask task)
Returns a specification for searching for recommended performers for a specified task.List<String>
getDisableFields(WorkflowableTask task)
Returns a list of fields that are not editable for a specified task.List<WorkflowTransition>
getTransitions(WorkflowableTask task)
Returns available transitions for the specified task.TransitionResult
invokeAutoTransition(WorkflowableTask task, WorkflowTransition transition)
Performing an automatic transition for the specified task.TransitionResult
invokeTransition(BcDescription bcDescription, WorkflowableTask task, WorkflowTransition transition, List<String> preInvokeParameters)
Performing a user-initiated transition for a specific taskboolean
isChildBcDisabled(BcIdentifier bcIdentifier, WorkflowableTask task)
Checks whether editing of child business components of a specified task is blocked.void
setCustomStep(WorkflowableTask task, WorkflowStep step)
Sets the specified task to the specified step of the corresponding transition model.void
setInitialStep(WorkflowableTask task)
Sets the specified task to the initial step of the corresponding transition model.
-
-
-
Method Detail
-
setInitialStep
void setInitialStep(WorkflowableTask task)
Sets the specified task to the initial step of the corresponding transition model. and typeWorkflowableTask.getTaskType()
of task.- Parameters:
task
- workflow task
-
setCustomStep
void setCustomStep(WorkflowableTask task, WorkflowStep step)
Sets the specified task to the specified step of the corresponding transition model.- Parameters:
task
- taskstep
- step of the transition model
-
getTransitions
List<WorkflowTransition> getTransitions(WorkflowableTask task)
Returns available transitions for the specified task.- Parameters:
task
- tasj- Returns:
- list of available transitions
-
invokeTransition
TransitionResult invokeTransition(BcDescription bcDescription, WorkflowableTask task, WorkflowTransition transition, List<String> preInvokeParameters)
Performing a user-initiated transition for a specific task- Parameters:
bcDescription
- description of the business component of a tasktask
- tasktransition
- transitionpreInvokeParameters
- the user's confirmation of the transition- Returns:
- result of the transition
-
invokeAutoTransition
TransitionResult invokeAutoTransition(WorkflowableTask task, WorkflowTransition transition)
Performing an automatic transition for the specified task.- Parameters:
task
- tasktransition
- transition- Returns:
- result of the transition
-
forceInvokeAutoTransition
void forceInvokeAutoTransition(WorkflowableTask task, WorkflowTransition transition)
Performing an automatic transition for a given task without checking its capability.- Parameters:
task
- tasktransition
- transition
-
forceInvokeAutoTransitionToHiddenStep
void forceInvokeAutoTransitionToHiddenStep(WorkflowableTask task)
Performing an automatic transition for a specified task to a step with the HIDDEN status, if it exists in the transition model.- Parameters:
task
- task
-
isChildBcDisabled
boolean isChildBcDisabled(BcIdentifier bcIdentifier, WorkflowableTask task)
Checks whether editing of child business components of a specified task is blocked.- Parameters:
bcIdentifier
- identifier of business component which is mapped to a tasktask
- task- Returns:
- whether editing of child business components is blocked
-
getDisableFields
List<String> getDisableFields(WorkflowableTask task)
Returns a list of fields that are not editable for a specified task.- Parameters:
task
- task- Returns:
- list of fields that can't be edited
-
getAssigneeRecommendationSpecification
org.springframework.data.jpa.domain.Specification<User> getAssigneeRecommendationSpecification(WorkflowableTask task)
Returns a specification for searching for recommended performers for a specified task.- Parameters:
task
- task- Returns:
- specification for searching for recommended performers
-
checkRequiredFieldsForTransition
boolean checkRequiredFieldsForTransition(WorkflowTransition transition)
Checks whether the required fields must be filled in to complete the specified transition..- Parameters:
transition
- transition- Returns:
- whether it is necessary to check filling of mandatory fields
-
forceInvokeAutoTransitionIgnorePostFunctions
TransitionResult forceInvokeAutoTransitionIgnorePostFunctions(WorkflowTransition transition, WorkflowableTask task)
Performing an automatic transition for a specified task without executing post functions and checking its capability.- Parameters:
transition
- transition to be performedtask
- task- Returns:
- result of the transition
-
-