org.bonitasoft.engine.core.process.instance.api

Interface GatewayInstanceService

All Known Implementing Classes:

GatewayInstanceServiceImpl

public interface GatewayInstanceService

Since:

6.0

Author:

Feng Hui, Baptiste Mesta, Matthieu Chaffotte

Field Summary

Fields

Modifier and Type	Field and Description
static String	FINISH
static String	GATEWAYINSTANCE
static String	GATEWAYINSTANCE_HITBYS
static String	GATEWAYINSTANCE_STATE

Method Summary

Modifier and Type	Method and Description
boolean	checkMergingCondition(SProcessDefinition sDefinition, SGatewayInstance gatewayInstance)
void	createGatewayInstance(SGatewayInstance gatewayInstance) Create gatewayInstance in DB according to the given gateway instance object
SGatewayInstance	getActiveGatewayInstanceOfTheProcess(long parentProcessInstanceId, String name) Get active gatewayInstance in the specific process instance
SGatewayInstance	getGatewayInstance(long gatewayInstanceId) Get gateway instance by its id
List<SGatewayInstance>	getInclusiveGatewaysOfProcessInstanceThatShouldFire(SProcessDefinition processDefinition, long processInstanceId)
void	hitTransition(SGatewayInstance gatewayInstance, long transitionIndex) Add transitionDefinitionName to hitBy of specific gatewayInstance
List<SGatewayInstance>	setFinishAndCreateNewGatewayForRemainingToken(SProcessDefinition processDefinition, SGatewayInstance gatewayInstance)
void	setState(SGatewayInstance gatewayInstance, int stateId) Change state of the specific gateway

Field Detail

FINISH

static final String FINISH

See Also:

Constant Field Values

GATEWAYINSTANCE

static final String GATEWAYINSTANCE

See Also:

Constant Field Values

GATEWAYINSTANCE_STATE

static final String GATEWAYINSTANCE_STATE

See Also:

Constant Field Values

GATEWAYINSTANCE_HITBYS

static final String GATEWAYINSTANCE_HITBYS

See Also:

Constant Field Values

Method Detail

createGatewayInstance

void createGatewayInstance(SGatewayInstance gatewayInstance)
                    throws SGatewayCreationException

Create gatewayInstance in DB according to the given gateway instance object

Parameters:

gatewayInstance - the gatewayInsttance object

Throws:

SGatewayCreationException

getGatewayInstance

SGatewayInstance getGatewayInstance(long gatewayInstanceId)
                             throws SGatewayNotFoundException,
                                    SGatewayReadException

Get gateway instance by its id

Parameters:

gatewayInstanceId - identifier of gateway instance

Returns:

an SGatewayInstance object

Throws:

SGatewayNotFoundException

SGatewayReadException

setState

void setState(SGatewayInstance gatewayInstance,
              int stateId)
       throws SGatewayModificationException

Change state of the specific gateway

Parameters:

gatewayInstance - the gateway instance will be updated

stateId - identifier of gateway state

Throws:

SGatewayModificationException

checkMergingCondition

boolean checkMergingCondition(SProcessDefinition sDefinition,
                              SGatewayInstance gatewayInstance)
                       throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Parameters:

sDefinition -

gatewayInstance -

Returns:

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

hitTransition

void hitTransition(SGatewayInstance gatewayInstance,
                   long transitionIndex)
            throws SGatewayModificationException,
                   SGatewayCreationException

Add transitionDefinitionName to hitBy of specific gatewayInstance

Parameters:

gatewayInstance - the gateway instance will be updated

transitionIndex - value will be added to hitBy of gatewayInstance

Throws:

SGatewayModificationException

SGatewayCreationException

getActiveGatewayInstanceOfTheProcess

SGatewayInstance getActiveGatewayInstanceOfTheProcess(long parentProcessInstanceId,
                                                      String name)
                                               throws SGatewayNotFoundException,
                                                      SGatewayReadException

Get active gatewayInstance in the specific process instance

Parameters:

parentProcessInstanceId - identifier of parent process instance

name - name of gateway instance

Returns:

Throws:

SGatewayNotFoundException

SGatewayReadException

setFinishAndCreateNewGatewayForRemainingToken

List<SGatewayInstance> setFinishAndCreateNewGatewayForRemainingToken(SProcessDefinition processDefinition,
                                                                     SGatewayInstance gatewayInstance)
                                                              throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

getInclusiveGatewaysOfProcessInstanceThatShouldFire

List<SGatewayInstance> getInclusiveGatewaysOfProcessInstanceThatShouldFire(SProcessDefinition processDefinition,
                                                                           long processInstanceId)
                                                                    throws SBonitaReadException

Throws:

SBonitaReadException