cz.wicketstuff.boss.flow.processor.IFlowProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of boss-flow Show documentation

Workflow control and configuration java framework

There is a newer version: 1.3.1

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 cz.wicketstuff.boss.flow.processor;

import java.io.Serializable;

import cz.wicketstuff.boss.flow.FlowException;
import cz.wicketstuff.boss.flow.model.IFlowCarter;
import cz.wicketstuff.boss.flow.model.IFlowState;
import cz.wicketstuff.boss.flow.model.IFlowTransition;
import cz.wicketstuff.boss.flow.validation.IFlowStateValidator;


/**
 * Service interface of payment flow.
 * This interface represents business logic of the flow.  
 * 
 * @author Martin Strejc
 *
 * @param  stepData class
 */
public interface IFlowProcessor extends 
	IFlowStateValidationListener, 
	IFlowStateChangeListener,
	IFlowTransitionChangeListener,
	IFlowStateValidator,
	IFlowStateProcessor,
	IFlowCarterFactory,
	IFlowStateDataFactory,
	IFlowTransitionResolver,
	IFlowTransitionChecker,
	IFlowStateResolver,
	IFlowStatePersister {	

	Integer getFlowId();

	String getFlowName();
	
	IFlowCarter initFlow(Long flowProcessId, T payload) throws FlowException;

	IFlowCarter initFlow(Long flowProcessId, T payload, IFlowState initialState) throws FlowException;

	IFlowCarter initFlow(Long flowProcessId, T payload, String initialStateName) throws FlowException;

	IFlowState getDefaultInitialState();
		
	boolean invokeTransition(IFlowCarter flow, IFlowTransition transition) throws FlowException;

	boolean invokeTransition(IFlowCarter flow, String transitionName) throws FlowException;

	boolean isCurrentState(IFlowCarter flow, IFlowState testedState);

	boolean isCurrentState(IFlowCarter flow, String testedFlowStateName);
	
}