com.flexive.shared.interfaces
Interface RouteEngine

All Known Subinterfaces:
RouteEngineLocal

public interface RouteEngine

Workflow route engine interface.

Author:
Gregor Schober (gregor.schober@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at), Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)

Method Summary
 long create(long fromStepId, long toStepId, long groupId)
          Creates a new route.
 java.util.List<Step> getTargets(long fromStep)
          Loads all possible to-steps.
 void remove(long routeId)
          Removes a route defined by its unique id.
 

Method Detail

getTargets

java.util.List<Step> getTargets(long fromStep)
                                throws FxApplicationException
Loads all possible to-steps.

Parameters:
fromStep - the from step
Returns:
all possible to-steps
Throws:
FxApplicationException - TODO
FxLoadException - if the function failed to load the steps
FxNotFoundException - if the from step does not exist

create

long create(long fromStepId,
            long toStepId,
            long groupId)
            throws FxApplicationException
Creates a new route.

The caller must be within ROLE_WORKFLOWMANAGEMENT.

Parameters:
fromStepId - the from step
toStepId - the to step
groupId - the authorised group
Returns:
the unique id of the new route
Throws:
FxApplicationException - TODO
FxInvalidParameterException - if invalid parameters were enountered
FxNotFoundException - if the from/to step or group does not exist
FxCreateException - if the creation failed (eg. from and to step are in a different workflow or ident)
FxNoAccessException - if the caller may not acces the group
FxEntryExistsException - if the route does already exist

remove

void remove(long routeId)
            throws FxApplicationException
Removes a route defined by its unique id.

The caller must be within ROLE_WORKFLOWMANAGEMENT.

Parameters:
routeId - the unique route id
Throws:
FxApplicationException - TODO
FxRemoveException - if the remove failed