View Javadoc
1   /**
2    * Copyright 2005-2014 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.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/ecl2.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  import org.kuali.rice.kew.actiontaken.ActionTakenValue;
19  import org.kuali.rice.kew.api.KewApiConstants;
20  
21  import java.util.Collections;
22  import java.util.HashSet;
23  import java.util.Set;
24  
25  
26  /**
27   * Specifies configuration for orchestration through the engine.
28   * 
29   * @author Kuali Rice Team (rice.collab@kuali.org)
30   */
31  public class OrchestrationConfig {
32  
33      public enum EngineCapability { STANDARD, BLANKET_APPROVAL, SIMULATION }
34      
35      private final EngineCapability capability;
36      private final boolean sendNotifications;
37      private final String notificationType = KewApiConstants.ACTION_REQUEST_ACKNOWLEDGE_REQ;
38      private final Set<String> destinationNodeNames;
39      private final ActionTakenValue cause;
40      private final boolean runPostProcessorLogic;
41      //KULRICE-12283: Added two new flags to indicate if acknowledgements and FYIs should be deactivated
42      private final boolean deactivateAcknowledgements;
43      private final boolean deactivateFYIs;
44      
45      public OrchestrationConfig(EngineCapability capability) {
46          this(capability, Collections.<String>emptySet(), null, true, true);
47      }
48      
49      public OrchestrationConfig(EngineCapability capability, boolean isRunPostProcessorLogic) {
50          this(capability, Collections.<String>emptySet(), null, true, isRunPostProcessorLogic);
51      }
52      
53      public OrchestrationConfig(EngineCapability capability, Set<String> destinationNodeNames, ActionTakenValue cause) {
54          this(capability, destinationNodeNames, cause, true, true);
55      }
56  
57      //KULRICE-12283: Added new constructors which set up the two new properties
58      public OrchestrationConfig(EngineCapability capability, Set<String> destinationNodeNames, ActionTakenValue cause, boolean sendNotifications, boolean doRunPostProcessorLogic) {
59          this(capability, destinationNodeNames, cause, sendNotifications, doRunPostProcessorLogic, false, false);
60      }
61  
62      public OrchestrationConfig(EngineCapability capability, Set<String> destinationNodeNames, ActionTakenValue cause, boolean sendNotifications, boolean doRunPostProcessorLogic, boolean deactivateAcknowledgements, boolean deactivateFYIs) {
63          this.capability = capability;
64          this.destinationNodeNames = Collections.unmodifiableSet(new HashSet<String>(destinationNodeNames));
65          this.cause = cause;
66          this.sendNotifications = sendNotifications;
67          this.runPostProcessorLogic = doRunPostProcessorLogic;
68          this.deactivateAcknowledgements = deactivateAcknowledgements;
69          this.deactivateFYIs = deactivateFYIs;
70      }
71  
72      public Set<String> getDestinationNodeNames() {
73          return destinationNodeNames;
74      }
75  
76      public String getNotificationType() {
77          return notificationType;
78      }
79  
80      public boolean isSendNotifications() {
81          return sendNotifications;
82      }
83  
84      public ActionTakenValue getCause() {
85          return cause;
86      }
87  
88  	public boolean isRunPostProcessorLogic() {
89  		return this.runPostProcessorLogic;
90  	}
91  
92      /**
93       * @return the capability
94       */
95      public EngineCapability getCapability() {
96          return this.capability;
97      }
98  
99      //KULRICE-12283: Added getters for two new properties
100     public boolean isDeactivateAcknowledgements() {
101         return deactivateAcknowledgements;
102     }
103 
104     public boolean isDeactivateFYIs() {
105         return deactivateFYIs;
106     }
107     
108 }