01: /***************************************************************
02: * This file is part of the [fleXive](R) project.
03: *
04: * Copyright (c) 1999-2008
05: * UCS - unique computing solutions gmbh (http://www.ucs.at)
06: * All rights reserved
07: *
08: * The [fleXive](R) project is free software; you can redistribute
09: * it and/or modify it under the terms of the GNU General Public
10: * License as published by the Free Software Foundation;
11: * either version 2 of the License, or (at your option) any
12: * later version.
13: *
14: * The GNU General Public License can be found at
15: * http://www.gnu.org/copyleft/gpl.html.
16: * A copy is found in the textfile GPL.txt and important notices to the
17: * license from the author are found in LICENSE.txt distributed with
18: * these libraries.
19: *
20: * This library is distributed in the hope that it will be useful,
21: * but WITHOUT ANY WARRANTY; without even the implied warranty of
22: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23: * GNU General Public License for more details.
24: *
25: * For further information about UCS - unique computing solutions gmbh,
26: * please see the company website: http://www.ucs.at
27: *
28: * For further information about [fleXive](R), please see the
29: * project website: http://www.flexive.org
30: *
31: *
32: * This copyright notice MUST APPEAR in all copies of the file!
33: ***************************************************************/package com.flexive.shared.interfaces;
34:
35: import com.flexive.shared.exceptions.*;
36: import com.flexive.shared.workflow.Workflow;
37:
38: import javax.ejb.Remote;
39:
40: /**
41: * The workflow class represets a workflow that defines steps that are connected
42: * through routes.
43: */
44: @Remote
45: public interface WorkflowEngine {
46:
47: /**
48: * Remove a workflow defined by its unique workflowId.
49: * <p/>
50: * The caller must be within ROLE_WORKFLOWMANAGEMENT.
51: * @param workflowId the unique workflowId of the workflow to removed
52: * @throws FxApplicationException TODO
53: * @throws FxNotFoundException if the workflow defined by its workflowId does not exist
54: * @throws FxRemoveException if the remove failed
55: * @throws FxNoAccessException if the caller lacks the permissions to remove a workflow
56: */
57: void remove(long workflowId) throws FxApplicationException;
58:
59: /**
60: * Modifies a workflow.
61: * <p/>
62: * The caller must be within ROLE_WORKFLOWMANAGEMENT.
63: * @param workflow TODO
64: * @throws FxApplicationException TODO
65: * @throws FxInvalidParameterException if a invalid parameter was encountered
66: * @throws FxNotFoundException if the workflow does not exist
67: * @throws FxUpdateException if the update failed
68: * @throws FxNoAccessException if the caller lacks the permissions to update the workflow
69: * @throws FxEntryExistsException if a workflow with the new name already exists
70: * @throws FxCreateException if a step could not be created
71: * @throws FxRemoveException if a removed workflow route could not be removed
72: * @throws FxEntryInUseException if a removed workflow step is still in use
73: */
74: void update(Workflow workflow) throws FxApplicationException;
75:
76: /**
77: * Creates a new workflow.
78: * <p/>
79: * The caller must be within ROLE_WORKFLOWMANAGEMENT.
80: *
81: * @param workflow the workflow to be created (the ID attribute is ignored)
82: * @return the ID of the created workflow
83: * @throws FxApplicationException TODO
84: * @throws FxCreateException if the creation failed
85: * @throws FxEntryExistsException if a workflow with the given name already exists
86: * @throws FxNoAccessException if the caller lacks the permissions to remove the workflow
87: * @throws FxInvalidParameterException If a parameter is invalid
88: */
89: long create(Workflow workflow) throws FxApplicationException;
90:
91: }
|