| com.flexive.shared.interfaces.StepEngine
All known Subclasses: com.flexive.ejb.beans.workflow.StepEngineBean,
| StepEngine | | public interface StepEngine (Code) | | The StepEngine class represents a step instance within a workflow
author:
Gregor Schober (gregor.schober@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
author:
Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at) |
| Method Summary | |
| long | createStep(Step step)
Creates a step in a workflow. | | List<StepPermission> | loadAllStepsForUser(long userId)
Returns all steps that a user has some kind of access to, combined with the
the permissions for the user on the step. | | void | removeStep(long stepId)
Removes a step defined by its unique id. | | void | removeSteps(long workflowId)
Removes all steps within a workflow. | | void | updateStep(long stepId, long aclId)
Updates a step specified by its unique id. |
| createStep | | long createStep(Step step) throws FxApplicationException(Code) | | Creates a step in a workflow.
The caller must be within ROLE_WORKFLOWMANAGEMENT.
No Exception is thrown if the step already exists within the workflow.
If a unique target step is needed and not defined it will be created using the provided aclId.
Parameters:
step - the step to be created the unique id of the new step
throws:
FxApplicationException - TODO
throws:
FxCreateException - if the creation of the step failed
throws:
FxNoAccessException - if the caller lacks the permissions to create the step |
| loadAllStepsForUser | | List<StepPermission> loadAllStepsForUser(long userId) throws FxApplicationException(Code) | | Returns all steps that a user has some kind of access to, combined with the
the permissions for the user on the step.
The function does not check id the specified user exists, it will return an empty result
for non existing entries.
Only GLOBAL_SUPERVISOR may call this function for all users, other users may only query themselfs.
Parameters:
userId - the user to get the steps for a array holding all Steps with its ACLs for the user
throws:
FxApplicationException - TODO
throws:
FxLoadException - if the load failed
throws:
FxNoAccessException - if the calling user may not load the requested steps |
| removeStep | | void removeStep(long stepId) throws FxApplicationException(Code) | | Removes a step defined by its unique id.
The caller has to be within ROLE_WORKFLOWMANAGEMENT.
The function does not throw a Exception if the step does not exist.
Parameters:
stepId - the unique step id
throws:
FxApplicationException - TODO
throws:
FxNoAccessException - if the caller lacks the permissions to remove the steps
throws:
FxRemoveException - if the remove failed
throws:
FxEntryInUseException - if the step is needed by another step as unique target can connot be removed |
|
|