nosu
/
taskana
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

TSK-1944: expanded Javadoc for review SPIs to include force methods

This commit is contained in:
Mustapha Zorgati 2022-08-16 07:56:48 +02:00
parent d8ffdb1824
commit 62844c7b9f
4 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lib/taskana-core/src/main/java/pro/taskana/spi/task/api/AfterRequestChangesProvider.java
View File

@ -23,7 +23,8 @@ public interface AfterRequestChangesProvider {
/**
* Perform any action after changes have been requested on a {@linkplain Task} through {@linkplain
* pro.taskana.task.api.TaskService#requestChanges(String)}.
* pro.taskana.task.api.TaskService#requestChanges(String)} or {@linkplain
* pro.taskana.task.api.TaskService#forceRequestChanges(String)}.
*
* <p>This SPI is executed within the same transaction staple as {@linkplain
* pro.taskana.task.api.TaskService#requestChanges(String)}.
@ -34,7 +35,8 @@ public interface AfterRequestChangesProvider {
* pro.taskana.task.api.TaskService#requestChanges(String)}.
*
* @param task the {@linkplain Task} after {@linkplain
* pro.taskana.task.api.TaskService#requestChanges(String)} has completed
* pro.taskana.task.api.TaskService#requestChanges(String)} or {@linkplain
* pro.taskana.task.api.TaskService#forceRequestChanges(String)} has completed
* @return the modified {@linkplain Task}. <b>IMPORTANT:</b> persistent changes to the {@linkplain
* Task} have to be managed by the service provider
* @throws Exception if the service provider throws any exception

6
lib/taskana-core/src/main/java/pro/taskana/spi/task/api/AfterRequestReviewProvider.java
View File

@ -23,7 +23,8 @@ public interface AfterRequestReviewProvider {
/**
* Perform any action after a review has been requested on a {@linkplain Task} through {@linkplain
* pro.taskana.task.api.TaskService#requestReview(String)}.
* pro.taskana.task.api.TaskService#requestReview(String)} or {@linkplain
* pro.taskana.task.api.TaskService#forceRequestReview(String)}.
*
* <p>This SPI is executed within the same transaction staple as {@linkplain
* pro.taskana.task.api.TaskService#requestReview(String)}.
@ -34,7 +35,8 @@ public interface AfterRequestReviewProvider {
* pro.taskana.task.api.TaskService#requestReview(String)}.
*
* @param task the {@linkplain Task} after {@linkplain
* pro.taskana.task.api.TaskService#requestReview(String)} has completed
* pro.taskana.task.api.TaskService#requestReview(String)} or {@linkplain
* pro.taskana.task.api.TaskService#forceRequestReview(String)} has completed
* @return the modified {@linkplain Task}. <b>IMPORTANT:</b> persistent changes to the {@linkplain
* Task} have to be managed by the service provider
* @throws Exception if the service provider throws any exception

6
lib/taskana-core/src/main/java/pro/taskana/spi/task/api/BeforeRequestChangesProvider.java
View File

@ -23,7 +23,8 @@ public interface BeforeRequestChangesProvider {
/**
* Perform any action before changes have been requested on a {@linkplain Task} through
* {@linkplain pro.taskana.task.api.TaskService#requestChanges(String)}.
* {@linkplain pro.taskana.task.api.TaskService#requestChanges(String)} or {@linkplain
* pro.taskana.task.api.TaskService#forceRequestChanges(String)}.
*
* <p>This SPI is executed within the same transaction staple as {@linkplain
* pro.taskana.task.api.TaskService#requestChanges(String)}.
@ -34,7 +35,8 @@ public interface BeforeRequestChangesProvider {
* pro.taskana.task.api.TaskService#requestChanges(String)}.
*
* @param task the {@linkplain Task} before {@linkplain
* pro.taskana.task.api.TaskService#requestChanges(String)} has started
* pro.taskana.task.api.TaskService#requestChanges(String)} or {@linkplain
* pro.taskana.task.api.TaskService#forceRequestChanges(String)} has started
* @return the modified {@linkplain Task}. <b>IMPORTANT:</b> persistent changes to the {@linkplain
* Task} have to be managed by the service provider
* @throws Exception if the service provider throws any exception

6
lib/taskana-core/src/main/java/pro/taskana/spi/task/api/BeforeRequestReviewProvider.java
View File

@ -23,7 +23,8 @@ public interface BeforeRequestReviewProvider {
/**
* Perform any action before a review has been requested on a {@linkplain Task} through
* {@linkplain pro.taskana.task.api.TaskService#requestReview(String)}.
* {@linkplain pro.taskana.task.api.TaskService#requestReview(String)} or {@linkplain
* pro.taskana.task.api.TaskService#forceRequestReview(String)}.
*
* <p>This SPI is executed within the same transaction staple as {@linkplain
* pro.taskana.task.api.TaskService#requestReview(String)}.
@ -34,7 +35,8 @@ public interface BeforeRequestReviewProvider {
* pro.taskana.task.api.TaskService#requestReview(String)}.
*
* @param task the {@linkplain Task} before {@linkplain
* pro.taskana.task.api.TaskService#requestReview(String)} has started
* pro.taskana.task.api.TaskService#requestReview(String)} or {@linkplain
* pro.taskana.task.api.TaskService#forceRequestReview(String)} has started
* @return the modified {@linkplain Task}. <b>IMPORTANT:</b> persistent changes to the {@linkplain
* Task} have to be managed by the service provider
* @throws Exception if the service provider throws any exception