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

/*
 * Et netera, http://boss.etnetera.cz - Copyright (C) 2012 
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License (version 2.1) as published by the Free Software
 * Foundation.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * See the GNU Lesser General Public License for more details:
 * http://www.gnu.org/licenses/lgpl-3.0.txt
 * 
 */
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);
	
}