1 /*
2 * Copyright 2005-2007 The Kuali Foundation
3 *
4 *
5 * Licensed under the Educational Community License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.opensource.org/licenses/ecl2.php
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.kuali.rice.kew.engine.node.service;
18
19 import java.util.List;
20
21 import org.kuali.rice.kew.engine.node.Branch;
22
23 /**
24 * A service providing data access for {@link Branch} instances.
25 *
26 * @author Kuali Rice Team (rice.collab@kuali.org)
27 */
28 public interface BranchService {
29 public void save(Branch branch);
30 public void deleteBranchStates(List statesToBeDeleted);
31 /**
32 * Responsible for inspecting the branch hierarchy/scope and returning a value
33 * for the variable name if it exists somewere in scope.
34 * @param branch the lowermost scope to start resolution
35 * @return a value for the key if it exists somewere in scope
36 */
37 public String getScopedVariableValue(Branch branch, String name);
38 /**
39 * Responsible for setting a value in the branch hierarchy/scope. If the variable name
40 * exists in a scope, it will be updated as opposed to created in a lower scope.
41 * @param branch the lowermost scope to start resolution
42 * @param value the value to set for the variable
43 * @return the replaced value of the variable, if the variable was already defined, or null otherwise
44 */
45 public String setScopedVariableValue(Branch branch, String name, String value);
46 }