1 /** 2 * This file Copyright (c) 2003-2010 Magnolia International 3 * Ltd. (http://www.magnolia-cms.com). All rights reserved. 4 * 5 * 6 * This file is dual-licensed under both the Magnolia 7 * Network Agreement and the GNU General Public License. 8 * You may elect to use one or the other of these licenses. 9 * 10 * This file is distributed in the hope that it will be 11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the 12 * implied warranty of MERCHANTABILITY or FITNESS FOR A 13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT. 14 * Redistribution, except as permitted by whichever of the GPL 15 * or MNA you select, is prohibited. 16 * 17 * 1. For the GPL license (GPL), you can redistribute and/or 18 * modify this file under the terms of the GNU General 19 * Public License, Version 3, as published by the Free Software 20 * Foundation. You should have received a copy of the GNU 21 * General Public License, Version 3 along with this program; 22 * if not, write to the Free Software Foundation, Inc., 51 23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 24 * 25 * 2. For the Magnolia Network Agreement (MNA), this file 26 * and the accompanying materials are made available under the 27 * terms of the MNA which accompanies this distribution, and 28 * is available at http://www.magnolia-cms.com/mna.html 29 * 30 * Any modifications to this file must keep this entire header 31 * intact. 32 * 33 */ 34 package info.magnolia.module.workflow.flows; 35 36 import java.util.List; 37 38 import openwfe.org.engine.workitem.LaunchItem; 39 40 /** 41 * Manages flow definitions.Configures the item to use a specifig flow. 42 * @author philipp 43 * @version $Id: FlowDefinitionManager.java 32667 2010-03-13 00:37:06Z gjoseph $ 44 * 45 */ 46 public interface FlowDefinitionManager { 47 48 /** 49 * Configure the launchItem, so that it will use the workflow 50 */ 51 void configure(LaunchItem launchItem, String workflowName) throws FlowDefinitionException; 52 53 /** 54 * The flow name gets extracted out of the workflow definition. 55 * @param definition the workflow definition xml 56 */ 57 void saveDefinition(String definition) throws FlowDefinitionException; 58 59 /** 60 * Read the workflow definition stored with this name 61 */ 62 String readDefinition(String workflowName) throws FlowDefinitionException; 63 64 /** 65 * List all available workflow names 66 */ 67 List getDefinitionNames() throws FlowDefinitionException; 68 }