eu.vicci.process.model.sofiainstance.util

Class ProcessStepUtil

java.lang.Object

eu.vicci.process.model.sofiainstance.util.ProcessStepUtil

public class ProcessStepUtil
extends Object

Author:

Reik M�ller

Constructor Summary

Constructors

Constructor and Description
ProcessStepUtil()

Method Summary

Modifier and Type	Method and Description
static void	activateControlEndPorts(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst) Activating outgoing control ports.
static void	activateDataEndPorts(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst) Activating outgoing data ports. This method fills all EndDataPorts with their respective information simply by matching the names of all items of the field 'returnValue' and the names of the data fields of all EndDataPorts.
static void	aggregateStartParameter(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst) Getting the parameter from StartDataPorts. This method aggregates all parameters from all StartDataPorts and provides them by filling the field StartParameter.
static boolean	allPortsActive(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst) Checks if the AND aspect of the ProcessStep is full filled, meaning whether all in going Ports are activated.
static void	cancelTimer(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst) Canceling timer to give free resources and to let the application terminate correctly.
static void	changeExecutionState(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst, eu.vicci.process.model.sofiainstance.State state) Changing execution state. This method sets the ExecutionState and can be used to perform standard behavior related to execution state changes like informing the user interfaces.
static void	configure(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst, eu.vicci.process.model.sofiainstance.Configuration conf)
static void	consoleOutput(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst, String info)
static void	deploy(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst, eu.vicci.process.model.sofiainstance.MappingUtil mapper)
static boolean	execute(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst)
static void	executeDelay(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst) Delays the execution for a certain time span.
static void	forwardReactivation(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst) Forwards a start or execute call in the case that the ProcessStep is in state EXECUTED. This method is used to propagate the reactivating start or execute call after the entire process had been paused or stopped.
static void	setDelay(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst, long newDelay) Setting an new delay.
static void	setPermission(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst, eu.vicci.process.model.sofiainstance.ExecutionPermission newPermission) Setting the a new execution permission.
static void	startSubProcesses(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst) Telling the StartPorts to execute linked SubProcessSteps.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessStepUtil

public ProcessStepUtil()

Method Detail

execute

public static boolean execute(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst)

setPermission

public static void setPermission(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst,
                                 eu.vicci.process.model.sofiainstance.ExecutionPermission newPermission)

Setting the a new execution permission. In case that the ProcessStep might be activated but blocked (for example by the execution permission "execution denied" the ProcessStep will be activated immediately.

Parameters:

inst - The ProcessStep instance that is delegating the work.

newPermission - The new execution permission

setDelay

public static void setDelay(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst,
                            long newDelay)

Setting an new delay. The delay describes how much time the process step waits between getting an activation that leads to the execution of the process step and the access of the execution routine. In case that the process step is already in the delay phase setting a new delay reschedules the the process step. Thus the delay can be shortened or extended.

Parameters:

inst - The ProcessStep instance that is delegating the work.

newDelay - The new delay in milliseconds.

allPortsActive

public static boolean allPortsActive(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst)

Checks if the AND aspect of the ProcessStep is full filled, meaning whether all in going Ports are activated. Please note that there might be ports that are not necessary for execution. These are marked with an optional flag and are considered in the AND-aspect decision.

Parameters:

inst - The ProcessStep instance that is delegating the work.

Returns:

True if all StartPorts are activated. False if one or more StartPorts are not activated.

forwardReactivation

public static void forwardReactivation(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst)

Forwards a start or execute call in the case that the ProcessStep is in state EXECUTED.

This method is used to propagate the reactivating start or execute call after the entire process had been paused or stopped. The ProcessStep itself will not be executed again.

Parameters:

inst - The ProcessStep instance that is delegating the work.

changeExecutionState

public static void changeExecutionState(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst,
                                        eu.vicci.process.model.sofiainstance.State state)

Changing execution state.

This method sets the ExecutionState and can be used to perform standard behavior related to execution state changes like informing the user interfaces.

Parameters:

state - The new ExecutionState

inst - The ProcessStep instance that is delegating the work.

startSubProcesses

public static void startSubProcesses(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst)

Telling the StartPorts to execute linked SubProcessSteps.

Parameters:

inst - The ProcessStep instance that is delegating the work.

cancelTimer

public static void cancelTimer(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst)

Canceling timer to give free resources and to let the application terminate correctly.

Parameters:

inst - The ProcessStep instance that is delegating the work.

aggregateStartParameter

public static void aggregateStartParameter(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst)

Getting the parameter from StartDataPorts.

This method aggregates all parameters from all StartDataPorts and provides them by filling the field StartParameter.

Parameters:

inst - The ProcessStep instance that is delegating the work.

activateDataEndPorts

public static void activateDataEndPorts(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst)

Activating outgoing data ports.

This method fills all EndDataPorts with their respective information simply by matching the names of all items of the field 'returnValue' and the names of the data fields of all EndDataPorts.

Parameters:

inst - The ProcessStep instance that is delegating the work.

activateControlEndPorts

public static void activateControlEndPorts(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst)

Activating outgoing control ports.

Parameters:

inst - The ProcessStep instance that is delegating the work.

executeDelay

public static void executeDelay(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst)

Delays the execution for a certain time span.

The delay used has to be specified by using the method configure(). The standard delay is specified in the constructor. Using the timer the control flow goes directly back to the caller. A delay of zero can be used to decouple the control flow but this is neither the correct way to do so (please use the flag "isDecoupled" in the configuration class) nor is it recommended due to overhead.

Parameters:

inst - The ProcessStep instance that is delegating the work.

deploy

public static void deploy(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst,
                          eu.vicci.process.model.sofiainstance.MappingUtil mapper)

configure

public static void configure(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst,
                             eu.vicci.process.model.sofiainstance.Configuration conf)

consoleOutput

public static void consoleOutput(eu.vicci.process.model.sofiainstance.ProcessStepInstance inst,
                                 String info)