Package pro.taskana.spi.task.api

Interface BeforeRequestReviewProvider

public interface BeforeRequestReviewProvider

The BeforeRequestReviewProvider allows to implement customized behaviour before a review has been requested on a given Task.

Method Summary

Modifier and Type	Method	Description
Task	beforeRequestReview(Task task)	Perform any action before a review has been requested on a Task through TaskService.requestReview(String) or TaskService.forceRequestReview(String).
void	initialize(TaskanaEngine taskanaEngine)	Provide the active TaskanaEngine which is initialized for this TASKANA installation.

Method Details

initialize

void initialize(TaskanaEngine taskanaEngine)

Provide the active TaskanaEngine which is initialized for this TASKANA installation.

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

Parameters:

taskanaEngine - the active TaskanaEngine which is initialized for this installation

beforeRequestReview

Task beforeRequestReview(Task task)
                  throws Exception

Perform any action before 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 before TaskService.requestReview(String) or TaskService.forceRequestReview(String) has started

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