javax.batch.api.Decider Maven / Gradle / Ivy
/*
* Copyright 2012 International Business Machines Corp.
*
* See the NOTICE file distributed with this work for additional information
* regarding copyright ownership. 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 javax.batch.api;
import javax.batch.runtime.StepExecution;
/**
* Decider determines batch exit status and to influence
* sequencing between steps, splits, and flows in a Job XML.
* The decider returns a String value which becomes the exit
* status value on which the decision chooses the next transition.
*
* @param specifies the type of the transient data in the
* batch context.
*/
public interface Decider {
/**
* The decide method receives control during job processing to
* set exit status between a step, split, or flow. The return
* value updates the current job execution's exit status.
* @param ctx specifies the last execution element's batch context.
* @return updated job exit status
* @throws Exception is thrown if an error occurs.
*/
/**
* The decide method receives control during job processing to
* set exit status between a step, split, or flow. The return
* value updates the current job execution's exit status. This
* decide method signature with a single StepStatus input receives
* control following a step or a flow. In the case of a flow, the
* StepStatus is from the last step to execute in the flow.
* @param execution specifies the StepExecution of the preceding step.
* @return updated job exit status
* @throws Exception is thrown if an error occurs.
*/
public String decide(StepExecution execution) throws Exception;
/**
* The decide method receives control during job processing to
* set exit status between a step, split, or flow. The return
* value updates the current job execution's exit status. This
* decide method signature with an array of StepExecution input
* receives control following a split. The array contains a
* StepExecution from the last step to execute in each flow of
* the split.
* @param executions specifies the StepExecutions of the preceding
* steps.
* @return updated job exit status
* @throws Exception is thrown if an error occurs.
*/
public String decide(StepExecution[] executions) throws Exception;
}