org.alfresco.service.cmr.workflow

Interface WorkflowAdminService

All Known Implementing Classes:

WorkflowAdminServiceImpl

public interface WorkflowAdminService

Client facing API for providing administration information about the WorkflowService.

Since:

4.0

Author:

Gavin Cornwell

Method Summary

Modifier and Type	Method and Description
boolean	isEngineEnabled(String engineId) Determines whether the engine with the given id is enabled.
boolean	isEngineVisible(String engineId) Determines whether the workflow definitions are visible for the engine with the given id.
void	setEngineEnabled(String engineId, boolean isEnabled) Enables/disables the engine with the given id.
void	setEngineVisibility(String engineId, boolean isVisible) Sets the visiblity of workflow definitions for the engine with the given id.

Method Detail

isEngineEnabled

boolean isEngineEnabled(String engineId)

Determines whether the engine with the given id is enabled.

Parameters:

engineId - The id of a workflow engine

Returns:

true if the engine id is valid and is enabled

setEngineEnabled

void setEngineEnabled(String engineId,
                      boolean isEnabled)

Enables/disables the engine with the given id.

Parameters:

engineId - The id of a workflow engine

isEnabled - true to enable the engine, false to disable

isEngineVisible

boolean isEngineVisible(String engineId)

Determines whether the workflow definitions are visible for the engine with the given id. NOTE: Workflow definitions can always be retrieved directly i.e. via name or id

Parameters:

engineId - The id of a workflow engine

Returns:

true if the definitions are visible

setEngineVisibility

void setEngineVisibility(String engineId,
                         boolean isVisible)

Sets the visiblity of workflow definitions for the engine with the given id. NOTE: Workflow definitions can always be retrieved directly i.e. via name or id

Parameters:

engineId - The id of a workflow engine

isVisible - true if the definitions are visible