Package org.tkit.rhpam.quarkus.process
Interface ProcessStepService
-
- All Known Implementing Classes:
BusinessErrorHandlerStepService
public interface ProcessStepServiceThe interface Process step service.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ProcessStepExecutionResultdoExecute(ProcessStepExecution workItem)Execute the process work item.default AdditionalErrorInfoprovideErrorInformation(ProcessStepExecution workItem, Exception e)Provide any additional error information in case the processing of#doExecutehas failed.
-
-
-
Method Detail
-
doExecute
ProcessStepExecutionResult doExecute(ProcessStepExecution workItem) throws RhpamException
Execute the process work item.When you want to indicate a negative outcome, handled by the Busiess Error Handler WIH, specify these 3 variables in output:
Constants.FAILED_STEP_ERROR_CODE- for error code,Constants.FAILED_STEP_ERROR_MSG- for error message text,Constants.FAILED_STEP_DEEP_LINK- for backlink to the failed object, e.g. link to Object detail in our UI view,- Parameters:
workItem- the process work item.- Returns:
- the result parameters for the workflow.
- Throws:
RhpamException- if the method fails.
-
provideErrorInformation
default AdditionalErrorInfo provideErrorInformation(ProcessStepExecution workItem, Exception e)
Provide any additional error information in case the processing of#doExecutehas failed.- Parameters:
workItem- workitem that failede- exception that occurred- Returns:
- instance of
AdditionalErrorInfo, most important attributes areerrorCodeanddeepLink- for back navigation from support tool.
-
-