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.Route;
37: import com.flexive.shared.workflow.Step;
38:
39: import javax.ejb.Remote;
40:
41: /**
42: * Workflow route engine interface.
43: *
44: * @author Gregor Schober (gregor.schober@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
45: * @author Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
46: */
47: @Remote
48: public interface RouteEngine {
49:
50: /**
51: * Loads all possible to-steps.
52: *
53: * @param fromStep the from step
54: * @return all possible to-steps
55: * @throws FxApplicationException TODO
56: * @throws FxLoadException if the function failed to load the steps
57: * @throws FxNotFoundException if the from step does not exist
58: */
59: Step[] getTargets(long fromStep) throws FxApplicationException;
60:
61: /**
62: * Returns all defined routes within a workflow.
63: *
64: * @param workflowId the unique workflow id
65: * @return all defined routes within a workflow
66: * @throws FxApplicationException TODO
67: * @throws FxLoadException if the function failed to read the routes
68: */
69: Route[] loadRoutes(long workflowId) throws FxApplicationException;
70:
71: /**
72: * Creates a new route.
73: * <p/>
74: * The caller must be within ROLE_WORKFLOWMANAGEMENT.
75: * @param fromStepId the from step
76: * @param toStepId the to step
77: * @param groupId the authorised group
78: * @return the unique id of the new route
79: * @throws FxApplicationException TODO
80: * @throws FxInvalidParameterException if invalid parameters were enountered
81: * @throws FxNotFoundException if the from/to step or group does not exist
82: * @throws FxCreateException if the creation failed (eg. from and to step are in a different workflow or ident)
83: * @throws FxNoAccessException if the caller may not acces the group
84: * @throws FxEntryExistsException if the route does already exist
85: */
86: long create(long fromStepId, long toStepId, long groupId)
87: throws FxApplicationException;
88:
89: /**
90: * Removes a route defined by its unique id.
91: * <p/>
92: * The caller must be within ROLE_WORKFLOWMANAGEMENT.<br>
93: * @param routeId the unique route id
94: * @throws FxApplicationException TODO
95: * @throws FxRemoveException if the remove failed
96: */
97: void remove(long routeId) throws FxApplicationException;
98:
99: }
|