1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.workflow.api;
23
24 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
25
26 /**
27 * Describes an operation or action to be performed as part of a workflow.
28 */
29 @XmlJavaTypeAdapter(WorkflowOperationDefinitionImpl.Adapter.class)
30 public interface WorkflowOperationDefinition extends Configurable {
31
32 String getId();
33
34 String getDescription();
35
36 /** The workflow to run if an exception is thrown while this operation is running. */
37 String getExceptionHandlingWorkflow();
38
39 /**
40 * If true, this workflow will be put into a failed (or failing, if getExceptionHandlingWorkflow() is not null) state
41 * when exceptions are thrown during an operation.
42 */
43 boolean isFailWorkflowOnException();
44
45 /**
46 * Returns either <code>null</code> or <code>true</code> to have the operation executed. Any other value is
47 * interpreted as <code>false</code> and will skip the operation.
48 * <p>
49 * Usually, this will be a variable name such as <code>${foo}</code>, which will be replaced with its acutal value
50 * once the workflow is executed.
51 * <p>
52 * If both <code>getExecuteCondition()</code> and <code>getSkipCondition</code> return a non-null value, the execute
53 * condition takes precedence.
54 *
55 * @return the excecution condition.
56 */
57 String getExecutionCondition();
58
59 /**
60 * Returns either <code>null</code> or <code>true</code> to have the operation skipped. Any other value is interpreted
61 * as <code>false</code> and will execute the operation.
62 * <p>
63 * Usually, this will be a variable name such as <code>${foo}</code>, which will be replaced with its actual value
64 * once the workflow is executed.
65 * <p>
66 * If both <code>getExecuteCondition()</code> and <code>getSkipCondition</code> return a non-null value, the execute
67 * condition takes precedence.
68 *
69 * @return the excecution condition.
70 */
71 String getSkipCondition();
72
73 /**
74 * Return the retry strategy
75 *
76 * @return the retry strategy
77 */
78 RetryStrategy getRetryStrategy();
79
80 /**
81 * Returns the number of attempts the workflow service will make to execute this operation.
82 *
83 * @return the maximum number of retries before failing
84 */
85 int getMaxAttempts();
86 }