001/*
002 * Copyright 2006-2018 the original author or authors.
003 *
004 * Licensed under the Apache 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 *      https://www.apache.org/licenses/LICENSE-2.0
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.springframework.batch.core.configuration;
017
018import org.springframework.batch.core.Job;
019import org.springframework.batch.core.launch.NoSuchJobException;
020import org.springframework.lang.Nullable;
021
022/**
023 * A runtime service locator interface for retrieving job configurations by
024 * <code>name</code>.
025 * 
026 * @author Dave Syer
027 * @author Mahmoud Ben Hassine
028 * 
029 */
030public interface JobLocator {
031
032        /**
033         * Locates a {@link Job} at runtime.
034         * 
035         * @param name the name of the {@link Job} which should be
036         * unique
037         * @return a {@link Job} identified by the given name
038         * 
039         * @throws NoSuchJobException if the required configuration can
040         * not be found.
041         */
042        Job getJob(@Nullable String name) throws NoSuchJobException;
043}