public interface ModuleControlService<M,F,C>

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`changeFlowStartupType(java.lang.String contextUrl, java.lang.String moduleName, java.lang.String flowName, java.lang.String startupType, java.lang.String comment)`	Set the flow startup type.
`boolean`	`changeFlowState(java.lang.String contextUrl, java.lang.String moduleName, java.lang.String flowName, java.lang.String action)`	Change the flow state.
`boolean`	`changeModuleActivationState(java.lang.String contextUrl, java.lang.String moduleName, java.lang.String action)`	Change the module activation state of a module.
`java.util.Optional<C>`	`getFlowStartupType(java.lang.String contextUrl, java.lang.String moduleName, java.lang.String flowName)`	Get the startup type of the flow.
`java.util.Optional<F>`	`getFlowState(java.lang.String contextUrl, java.lang.String moduleName, java.lang.String flowName)`	Get a metadata object for an individual flow.
`java.util.Optional<M>`	`getFlowStates(java.lang.String contextUrl, java.lang.String moduleName)`	Get a metadata object containing the states for all flows in a module.
`java.util.Optional<java.lang.String>`	`getModuleActivationState(java.lang.String contextUrl, java.lang.String moduleName)`	Get the module activation state.

Method Detail

getFlowStates

java.util.Optional<M> getFlowStates(java.lang.String contextUrl,
                                    java.lang.String moduleName)

Get a metadata object containing the states for all flows in a module.

Parameters:: contextUrl -; moduleName -
Returns:

getFlowState

java.util.Optional<F> getFlowState(java.lang.String contextUrl,
                                   java.lang.String moduleName,
                                   java.lang.String flowName)

Get a metadata object for an individual flow.

Parameters:: contextUrl -; moduleName -; flowName -
Returns:

changeFlowState

boolean changeFlowState(java.lang.String contextUrl,
                        java.lang.String moduleName,
                        java.lang.String flowName,
                        java.lang.String action)

Change the flow state. Supports actions 'start', 'startPause', 'pause', 'resume', 'stop'.

Parameters:: contextUrl -; moduleName -; flowName -; action -
Returns:

changeFlowStartupType
```
boolean changeFlowStartupType(java.lang.String contextUrl,
                              java.lang.String moduleName,
                              java.lang.String flowName,
                              java.lang.String startupType,
                              java.lang.String comment)
```
Set the flow startup type. Supports types 'manual', 'automatic', 'disabled'. 'manual' requires a flow to be manually started. 'automatic' will automatically restart a flow when a module is restarted. 'disabled' a flow cannot be started.

Parameters:

contextUrl -

moduleName -

flowName -

startupType -

comment -

Returns:

getFlowStartupType

java.util.Optional<C> getFlowStartupType(java.lang.String contextUrl,
                                         java.lang.String moduleName,
                                         java.lang.String flowName)

Get the startup type of the flow.

Parameters:: contextUrl -; moduleName -; flowName -
Returns:

changeModuleActivationState
```
boolean changeModuleActivationState(java.lang.String contextUrl,
                                    java.lang.String moduleName,
                                    java.lang.String action)
```
Change the module activation state of a module.

Parameters:

contextUrl - - url of service to call

moduleName - - the name of the module

action - - 'activate' or 'deactivate'

Returns:

true if successful otherwise false

getModuleActivationState

java.util.Optional<java.lang.String> getModuleActivationState(java.lang.String contextUrl,
                                                              java.lang.String moduleName)

Get the module activation state.

Parameters:: contextUrl - - url of service to call; moduleName - - the name of the module
Returns:: 'activated' or 'deactivated'

Interface ModuleControlService<M,​F,​C>