001/**
002 * Copyright 2005-2017 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kew.engine.node.service;
017
018import java.util.List;
019
020import org.kuali.rice.kew.engine.node.Branch;
021import org.kuali.rice.kew.engine.node.BranchState;
022
023/**
024 * A service providing data access for {@link Branch} instances.
025 *
026 * @author Kuali Rice Team (rice.collab@kuali.org)
027 */
028public interface BranchService {
029    public void save(Branch branch);    
030    public void deleteBranchStates(List<BranchState> statesToBeDeleted);
031    /**
032     * Responsible for inspecting the branch hierarchy/scope and returning a value
033     * for the variable name if it exists somewere in scope. 
034     * @param branch the lowermost scope to start resolution
035     * @return a value for the key if it exists somewere in scope
036     */
037    public String getScopedVariableValue(Branch branch, String name);
038    /**
039     * Responsible for setting a value in the branch hierarchy/scope.  If the variable name
040     * exists in a scope, it will be updated as opposed to created in a lower scope.  
041     * @param branch the lowermost scope to start resolution
042     * @param value the value to set for the variable
043     * @return the replaced value of the variable, if the variable was already defined, or null otherwise
044     */
045    public String setScopedVariableValue(Branch branch, String name, String value);
046}