Package io.kadai.spi.task.api

Interface AfterRequestReviewProvider

public interface AfterRequestReviewProvider

The AfterRequestReviewProvider allows to implement customized behaviour after a review has been requested on a given Task.

Method Summary

Modifier and Type	Method	Description
Task	afterRequestReview(Task task)	Perform any action after a review has been requested on a Task through TaskService.requestReview(String) or TaskService.forceRequestReview(String).
default Task	afterRequestReview(Task task, String workbasketId, String ownerId)	Perform any action after a review has been requested on a Task through TaskService.requestReview(String) or TaskService.forceRequestReview(String).
void	initialize(KadaiEngine kadaiEngine)	Provide the active KadaiEngine which is initialized for this KADAI installation.

Method Details

initialize

void initialize(KadaiEngine kadaiEngine)

Provide the active KadaiEngine which is initialized for this KADAI installation.

This method is called during KADAI startup and allows the service provider to store the active KadaiEngine for later usage.

Parameters:

kadaiEngine - the active KadaiEngine which is initialized for this installation

afterRequestReview

Task afterRequestReview(Task task)
                 throws Exception

Perform any action after a review has been requested on a Task through TaskService.requestReview(String) or TaskService.forceRequestReview(String).

This SPI is executed within the same transaction staple as TaskService.requestReview(String).

This SPI is executed with the same UserPrincipal and GroupPrincipal as in TaskService.requestReview(String).

Parameters:

task - the Task after TaskService.requestReview(String) or TaskService.forceRequestReview(String) has completed

Returns:

the modified Task. IMPORTANT: persistent changes to the Task have to be managed by the service provider

Throws:

Exception - if the service provider throws any exception

afterRequestReview

default Task afterRequestReview(Task task,
 String workbasketId,
 String ownerId)
                         throws Exception

Perform any action after a review has been requested on a Task through TaskService.requestReview(String) or TaskService.forceRequestReview(String).

This SPI is executed within the same transaction staple as TaskService.requestReview(String).

This SPI is executed with the same UserPrincipal and GroupPrincipal as in TaskService.requestReview(String).

Parameters:

task - the Task after TaskService.requestReview(String) or TaskService.forceRequestReview(String) has completed

workbasketId - the workbasketId the Task should be moved to

ownerId - the ownerId the Task should be assigned to

Returns:

the modified Task. IMPORTANT: persistent changes to the Task have to be managed by the service provider

Throws:

Exception - if the service provider throws any exception