Package pro.taskana.spi.task.api
Interface BeforeRequestChangesProvider
-
public interface BeforeRequestChangesProviderThe BeforeRequestChangesProvider allows to implement customized behaviour before changes have been requested on a given Task.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TaskbeforeRequestChanges(Task task)Perform any action before changes have been requested on a Task through TaskService.requestChanges(String) or TaskService.forceRequestChanges(String).voidinitialize(TaskanaEngine taskanaEngine)Provide the active TaskanaEngine which is initialized for this TASKANA installation.
-
-
-
Method Detail
-
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
-
beforeRequestChanges
Task beforeRequestChanges(Task task) throws Exception
Perform any action before changes have been requested on a Task through TaskService.requestChanges(String) or TaskService.forceRequestChanges(String).This SPI is executed within the same transaction staple as TaskService.requestChanges(String).
This SPI is executed with the same UserPrincipal and GroupPrincipal as in TaskService.requestChanges(String).
- Parameters:
task- the Task before TaskService.requestChanges(String) or TaskService.forceRequestChanges(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
-
-