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.StepDefinition;
37:
38: import javax.ejb.Remote;
39:
40: /**
41: * Interface to the step definition engine.
42: *
43: * @author Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
44: */
45: @Remote
46: public interface StepDefinitionEngine {
47:
48: /**
49: * Creates a new step definition.
50: * <p/>
51: * The caller must be within ROLE_WORKFLOWMANAGEMENT.
52: *
53: * @param stepDefinition the step definition to be created
54: * @return The create step's ID
55: * @throws FxApplicationException TODO
56: * @throws FxCreateException if the creation of the step definition failed
57: * @throws FxNoAccessException if the caller lacks the permission to manage workflows
58: * @throws FxInvalidParameterException if a parameter is invalid (empty name, invalid target ..)
59: * @throws FxEntryExistsException If a step with the given name already exists
60: */
61: long create(StepDefinition stepDefinition)
62: throws FxApplicationException;
63:
64: /**
65: * Modifies a existing StepDefinition.
66: * <p/>
67: * The caller must be within ROLE_WORKFLOWMANAGEMENT.<br>
68: * If the modification adds/modifies a unique target all workflows are checked if a step with this definition
69: * exists, and if the new unqique target is defined. If the unqique target is missing in any workflow,
70: * it will be created using the ACL of the parent step.
71: *
72: * @param stepDefinition the stepdefinition to be stored
73: * @throws FxApplicationException TODO
74: * @throws FxNotFoundException if the StepDefinition referenced by the parameter id does not exist
75: * @throws FxNoAccessException if the caller lacks the permissions to modify the step
76: * @throws FxInvalidParameterException if the uniqueTarget id is invalid
77: * @throws FxUpdateException if the function failed to modify the step definition
78: */
79: void update(StepDefinition stepDefinition)
80: throws FxApplicationException;
81:
82: /**
83: * Removes a step definition.
84: * <p/>
85: * The caller must be within ROLE_WORKFLOWMANAGEMENT.
86: *
87: * @param id the unique id of the step definition to remove
88: * @throws FxApplicationException TODO
89: * @throws FxNotFoundException if the step definition to remove does not exist
90: * @throws FxNoAccessException if the caller lacks the permissions to remove the step definition
91: * @throws com.flexive.shared.exceptions.FxRemoveException if the remove failed
92: * @throws FxEntryInUseException if the step definition is used (needed) and cannot be removed
93: */
94: void remove(long id) throws FxApplicationException;
95: }
|