Package org.tkit.rhpam.quarkus.process

Interface ProcessStepService

All Known Implementing Classes:

BusinessErrorHandlerStepService

public interface ProcessStepService

The interface Process step service.

Method Summary

Modifier and Type	Method	Description
ProcessStepExecutionResult	doExecute(ProcessStepExecution workItem)	Execute the process work item.
default AdditionalErrorInfo	provideErrorInformation(ProcessStepExecution workItem, Exception exc)	Provide any additional error information in case the processing of #doExecute has failed.

Method Detail

doExecute

ProcessStepExecutionResult doExecute(ProcessStepExecution workItem)
                              throws RhpamException

Execute the process work item. If this method results in an exception, it is treated as Technical error in Tkit error handling. In case of exception, the tkit-rhpam will invoke provideErrorInformation(ProcessStepExecution, Exception) method, where you can provide error code, message and deeplink for better error analysis. If not provided and exception is of type RhpamException then its getErrorCode() is used as failed step error code.

When you want to indicate a negative outcome which should be handled by the Business Error Handler WIH later in the process, 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 exc)

Provide any additional error information in case the processing of #doExecute has failed. In case you dont want to provide any additional info, return null.

Parameters:

workItem - workitem that failed

exc - exception that occurred

Returns:

instance of AdditionalErrorInfo, most important attributes are errorCode and deepLink - for back navigation from support tool.