org.springframework.webflow.execution.FlowLocator Maven / Gradle / Ivy
/*
* Copyright 2002-2006 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.webflow.execution;
import org.springframework.webflow.Flow;
/**
* A runtime service locator interface for retrieving flow definitions by
* id
.
*
* Flow locators are needed at by flow execution managers at runtime to retrieve
* fully-configured Flow definitions to support launching new flow executions.
*
* @author Keith Donald
* @author Erwin Vervaet
*/
public interface FlowLocator {
/**
* Lookup the flow definition with the specified id
.
* @param id the flow definition id
* @return the flow definition
* @throws FlowLocatorException when a problem occured accessing the flow
* definition with the provided identifier
*/
public Flow getFlow(String id) throws FlowLocatorException;
}