Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
BlanketApproveEngineFactory |
|
| 1.0;1 |
1 | /* | |
2 | * Copyright 2011 The Kuali Foundation | |
3 | * | |
4 | * Licensed under the Educational Community License, Version 1.0 (the "License"); | |
5 | * you may not use this file except in compliance with the License. | |
6 | * You may obtain a copy of the License at | |
7 | * | |
8 | * http://www.opensource.org/licenses/ecl1.php | |
9 | * | |
10 | * Unless required by applicable law or agreed to in writing, software | |
11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
13 | * See the License for the specific language governing permissions and | |
14 | * limitations under the License. | |
15 | */ | |
16 | package org.kuali.rice.kew.engine; | |
17 | ||
18 | ||
19 | /** | |
20 | * A factory which can be used to construct a new BlanketApproveEngine. | |
21 | * | |
22 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
23 | */ | |
24 | public interface BlanketApproveEngineFactory { | |
25 | ||
26 | /** | |
27 | * Constructs a new BlanketApproveEngine using the given orchestration configuration. | |
28 | * Also receives a directive on whether or not post processing should be run during | |
29 | * blanket approval orchestration. | |
30 | * | |
31 | * <p>The resulting {@link BlanketApproveEngine} is not guaranteed to be thread safe. | |
32 | * | |
33 | * @param config the orchestration configuration to use for the BlanketApproveEngine | |
34 | * @param runPostProcessor indicates whether or not the document's PostProcessor should | |
35 | * be executed during blanket approval orchestration. | |
36 | * @return the initialized blanket approve engine | |
37 | */ | |
38 | public BlanketApproveEngine newEngine(OrchestrationConfig config, boolean runPostProcessor); | |
39 | ||
40 | /** | |
41 | * Constructs a new BlanketApproveEngine using the given orchestration configuration. | |
42 | * Is equivalent to invoking {@link #newEngine(OrchestrationConfig, boolean)} passing | |
43 | * "true" for runPostProcessor. | |
44 | * | |
45 | * <p>The resulting {@link BlanketApproveEngine} is not guaranteed to be thread safe. | |
46 | * | |
47 | * @param config the orchestration configuration to use for the BlanketApproveEngine | |
48 | * @return the initialized blanket approve engine | |
49 | */ | |
50 | public BlanketApproveEngine newEngine(OrchestrationConfig config); | |
51 | ||
52 | } |