From e3e2488680ff3e42fea200648e9728d85dbff740 Mon Sep 17 00:00:00 2001 From: Konrad Windszus Date: Wed, 9 Dec 2020 10:18:41 +0100 Subject: [PATCH] Clarify Javadoc to make clear that certain operations fail if there is no current execution --- .../java/io/adobe/cloudmanager/CloudManagerApi.java | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/main/java/io/adobe/cloudmanager/CloudManagerApi.java b/src/main/java/io/adobe/cloudmanager/CloudManagerApi.java index 32601c8..bf9c437 100644 --- a/src/main/java/io/adobe/cloudmanager/CloudManagerApi.java +++ b/src/main/java/io/adobe/cloudmanager/CloudManagerApi.java @@ -95,25 +95,25 @@ public interface CloudManagerApi { * @param programId the program id context of the pipeline * @param pipelineId the pipeline id of to find the execution * @return the execution details of the pipeline - * @throws CloudManagerApiException when any error occurs + * @throws CloudManagerApiException when any error occurs or if no current execution exists */ PipelineExecution getCurrentExecution(String programId, String pipelineId) throws CloudManagerApiException; /** - * Cancels the current execution of the specified pipeline, if any execution exists. + * Cancels the current execution of the specified pipeline. * * @param programId the program id context of the pipeline * @param pipelineId the id of the pipeline to cancel - * @throws CloudManagerApiException when any error occurs + * @throws CloudManagerApiException when any error occurs or if no current execution exists */ void cancelCurrentExecution(String programId, String pipelineId) throws CloudManagerApiException; /** - * Advances the current execution of the specified pipeline, if in an appropriate state. + * Advances the current execution of the specified pipeline. * * @param programId the program id context of the pipeline * @param pipelineId the id of the pipeline to cancel - * @throws CloudManagerApiException when any error occurs + * @throws CloudManagerApiException when any error occurs or if no current execution exists */ void advanceCurrentExecution(String programId, String pipelineId) throws CloudManagerApiException;