Interface IWorkflowManager

All Superinterfaces:

IDisposable, IEntity

public interface IWorkflowManager
extends IEntity

Manages the workflows.

Method Summary

Modifier and Type	Method	Description
void	appendWorkflowProcessNoteById(int processId, String note)	Appends the note to the existing workflow process notes.
void	appendWorkflowProcessNoteByUniqueId(String uniqueId, String note)	Appends the note to the existing workflow process notes.
void	cancelWorkflowProcessById(int processId)	Cancels the workflow process.
void	cancelWorkflowProcessByUniqueId(String uniqueId)	Cancels the workflow process.
void	cancelWorkflowProcesses(String sql)	Cancels workflow processes.
int	createWorkflowDefinition(WorkflowDefinitionCreateRequest request)	Creates a workflow definition.
int	createWorkflowDefinitionVersion(String definitionName, int scriptDocumentId)	Creates a workflow definition version.
int	createWorkflowProcessById(int definitionId, int definitionVersionId, String uniqueId, WorkflowProcessCreationStatus processStatus, String notes, WorkflowPriority priority, int directoryId, int contactProfileId, WorkflowNextTaskData firstTaskData, Attribute[] attributes)	Creates a workflow process.
int	createWorkflowProcessByName(String definitionName, String uniqueId, WorkflowProcessCreationStatus processStatus, String notes, WorkflowPriority priority, int directoryId, int contactProfileId, WorkflowNextTaskData firstTaskData, Attribute[] attributes)	Creates a workflow process.
void	deleteWorkflowDefinition(String definitionName)	Deletes a workflow definition.
void	deleteWorkflowDefinitionVersion(String definitionName, int definitionVersionId)	Deletes a workflow definition version.
IInstance	getInstance()	The instance.
WorkflowDefinition	getWorkflowDefinitionById(int definitionId)	Gets the workflow definition.
WorkflowDefinition	getWorkflowDefinitionByName(String definitionName)	Gets the workflow definition.
IWorkflowDefinitionCursor	getWorkflowDefinitionCursor(int cursorId)	Gets a workflow definition cursor open in the instance.
IWorkflowDefinitionCursor[]	getWorkflowDefinitionCursors()	Returns the workflow definition cursors open in the instance.
String[]	getWorkflowDefinitionNames()	Gets the names of the workflow definitions.
String[]	getWorkflowDefinitionNamesByService(int serviceId)	Gets the names of the workflow definitions names of the specified service.
WorkflowDefinition[]	getWorkflowDefinitions()	Gets the workflow definitions.
WorkflowDefinition[]	getWorkflowDefinitionsByService(int serviceId)	Gets the workflow definitions of a service.
TableSchema	getWorkflowDefinitionTableSchema()	Gets the table schema of the workflow definition.
WorkflowDefinitionVersion	getWorkflowDefinitionVersion(int definitionId, int definitionVersionId)	Gets the workflow definition version.
WorkflowProcess	getWorkflowProcessById(int processId)	Gets the workflow process.
WorkflowProcess	getWorkflowProcessByUniqueId(String uniqueId)	Gets the workflow process.
TableSchema	getWorkflowProcessTableSchema()	Gets the table schema to cancel workflow processes.
WorkflowTaskDefinition	getWorkflowTaskDefinition(int taskDefinitionId)	Gets the workflow task definition.
WorkflowTaskDefinitionVersion	getWorkflowTaskDefinitionVersion(int taskDefinitionId, int taskDefinitionVersionId)	Gets the workflow task definition version.
TableSchema	getWorkflowTaskTableSchema(String serviceName)	Gets the table schema to update workflow tasks.
IWorkflowDefinitionCursor	newWorkflowDefinitionCursor(String[] columns, String sql)	Opens a workflow definition cursor.
void	notifyWaitEventTaskById(int processId, String taskName, WorkflowNextTaskData nextTaskData, Attribute[] attributes)	Notifies of a wait event task.
void	notifyWaitEventTaskByUniqueId(String uniqueId, String taskName, WorkflowNextTaskData nextTaskData, Attribute[] attributes)	Notifies of a wait event task.
void	setWorkflowProcessNotesById(int processId, String notes)	Sets the workflow process notes.
void	setWorkflowProcessNotesByUniqueId(String uniqueId, String notes)	Sets the workflow process notes.
void	startWorkflowProcessById(int processId)	Starts the workflow process.
void	startWorkflowProcessByUniqueId(String uniqueId)	Starts the workflow process.
void	suspendWorkflowProcessById(int processId)	Suspends the workflow process.
void	suspendWorkflowProcessByUniqueId(String uniqueId)	Suspends the workflow process.
IWorkflowDefinitionCursor	tryGetWorkflowDefinitionCursor(int cursorId)	Gets a workflow definition cursor open in the instance or null if it doesn't exist.
void	updateWorkflowDefinition(String definitionName, WorkflowDefinitionUpdateRequest request)	Updates a workflow definition.
int	updateWorkflowTasks(String serviceName, String sql, WorkflowTaskUpdateRequest request)	Updates workflow tasks.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

appendWorkflowProcessNoteById

void appendWorkflowProcessNoteById(int processId,
 String note)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Appends the note to the existing workflow process notes.

Parameters:

processId - Identifier of the workflow process.

note - Note to append.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

appendWorkflowProcessNoteByUniqueId

void appendWorkflowProcessNoteByUniqueId(String uniqueId,
 String note)
                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Appends the note to the existing workflow process notes.

Parameters:

uniqueId - Unique identifier of the workflow process.

note - Note to append.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

cancelWorkflowProcessById

void cancelWorkflowProcessById(int processId)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Cancels the workflow process.

Parameters:

processId - Identifier of the workflow process.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

cancelWorkflowProcessByUniqueId

void cancelWorkflowProcessByUniqueId(String uniqueId)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Cancels the workflow process.

Parameters:

uniqueId - Unique identifier of the workflow process.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

cancelWorkflowProcesses

void cancelWorkflowProcesses(String sql)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Cancels workflow processes.

Parameters:

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createWorkflowDefinition

int createWorkflowDefinition(WorkflowDefinitionCreateRequest request)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a workflow definition.

Parameters:

request - Contains the fields that must be overwritten

Returns:

Identifier of the created workflow definition.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createWorkflowDefinitionVersion

int createWorkflowDefinitionVersion(String definitionName,
 int scriptDocumentId)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a workflow definition version.

Parameters:

definitionName - Name of the workflow definition.

scriptDocumentId - Identifier of the script document.

Returns:

The workflow definition version identifier.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createWorkflowProcessById

int createWorkflowProcessById(int definitionId,
 int definitionVersionId,
 String uniqueId,
 WorkflowProcessCreationStatus processStatus,
 String notes,
 WorkflowPriority priority,
 int directoryId,
 int contactProfileId,
 WorkflowNextTaskData firstTaskData,
 Attribute[] attributes)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a workflow process.

Parameters:

definitionId - Identifier of the workflow definition.

definitionVersionId - Identifier of the workflow definition version.

uniqueId - Unique identifier of the workflow process.

processStatus - Workflow process creation status.

notes - Notes.

priority - Workflow relative priority.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

firstTaskData - Data for the first workflow task.

attributes - Attributes of the new workflow process.

Returns:

The workflow process identifier.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createWorkflowProcessByName

int createWorkflowProcessByName(String definitionName,
 String uniqueId,
 WorkflowProcessCreationStatus processStatus,
 String notes,
 WorkflowPriority priority,
 int directoryId,
 int contactProfileId,
 WorkflowNextTaskData firstTaskData,
 Attribute[] attributes)
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a workflow process.

Parameters:

definitionName - Name of the workflow definition.

uniqueId - Unique identifier of the workflow process.

processStatus - Workflow process creation status.

notes - Notes.

priority - Workflow relative priority.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

firstTaskData - Data for the first workflow task.

attributes - Attributes of the new workflow process.

Returns:

The workflow process identifier.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteWorkflowDefinition

void deleteWorkflowDefinition(String definitionName)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a workflow definition.

Parameters:

definitionName - Name of the workflow definition.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteWorkflowDefinitionVersion

void deleteWorkflowDefinitionVersion(String definitionName,
 int definitionVersionId)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a workflow definition version.

Parameters:

definitionName - Name of the workflow definition.

definitionVersionId - Identifier of the workflow definition version.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstance

IInstance getInstance()
               throws Exception,
altitude.integrationServer.exceptions.ISException

The instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowDefinitionById

WorkflowDefinition getWorkflowDefinitionById(int definitionId)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the workflow definition.

Parameters:

definitionId - Identifier of the workflow definition.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowDefinitionByName

WorkflowDefinition getWorkflowDefinitionByName(String definitionName)
                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the workflow definition.

Parameters:

definitionName - Name of the workflow definition.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowDefinitionCursor

IWorkflowDefinitionCursor getWorkflowDefinitionCursor(int cursorId)
                                               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a workflow definition cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IWorkflowDefinitionCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowDefinitionCursors

IWorkflowDefinitionCursor[] getWorkflowDefinitionCursors()
                                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the workflow definition cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowDefinitionNames

String[] getWorkflowDefinitionNames()
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the names of the workflow definitions.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowDefinitionNamesByService

String[] getWorkflowDefinitionNamesByService(int serviceId)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the names of the workflow definitions names of the specified service.

Parameters:

serviceId - Identifier of the service.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowDefinitions

WorkflowDefinition[] getWorkflowDefinitions()
                                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the workflow definitions.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowDefinitionsByService

WorkflowDefinition[] getWorkflowDefinitionsByService(int serviceId)
                                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the workflow definitions of a service.

Parameters:

serviceId - Identifier of the service.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowDefinitionTableSchema

TableSchema getWorkflowDefinitionTableSchema()
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the workflow definition.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowDefinitionVersion

WorkflowDefinitionVersion getWorkflowDefinitionVersion(int definitionId,
 int definitionVersionId)
                                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the workflow definition version.

Parameters:

definitionId - Identifier of the workflow definition.

definitionVersionId - Identifier of the workflow definition version.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowProcessById

WorkflowProcess getWorkflowProcessById(int processId)
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the workflow process.

Parameters:

processId - Identifier of the workflow process.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowProcessByUniqueId

WorkflowProcess getWorkflowProcessByUniqueId(String uniqueId)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the workflow process.

Parameters:

uniqueId - Unique identifier of the workflow process.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowProcessTableSchema

TableSchema getWorkflowProcessTableSchema()
                                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema to cancel workflow processes.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowTaskDefinition

WorkflowTaskDefinition getWorkflowTaskDefinition(int taskDefinitionId)
                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the workflow task definition.

Parameters:

taskDefinitionId - Identifier of the workflow task definition.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowTaskDefinitionVersion

WorkflowTaskDefinitionVersion getWorkflowTaskDefinitionVersion(int taskDefinitionId,
 int taskDefinitionVersionId)
                                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the workflow task definition version.

Parameters:

taskDefinitionId - Identifier of the workflow task definition.

taskDefinitionVersionId - Identifier of the workflow task definition version.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowTaskTableSchema

TableSchema getWorkflowTaskTableSchema(String serviceName)
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema to update workflow tasks.

Parameters:

serviceName - Name of the service.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newWorkflowDefinitionCursor

IWorkflowDefinitionCursor newWorkflowDefinitionCursor(String[] columns,
 String sql)
                                               throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a workflow definition cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

Returns:

The IWorkflowDefinitionCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

notifyWaitEventTaskById

void notifyWaitEventTaskById(int processId,
 String taskName,
 WorkflowNextTaskData nextTaskData,
 Attribute[] attributes)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Notifies of a wait event task.

Parameters:

processId - Identifier of the workflow process.

taskName - Name of the workflow task.

nextTaskData - Data for the next workflow task.

attributes - Attributes of the workflow process.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

notifyWaitEventTaskByUniqueId

void notifyWaitEventTaskByUniqueId(String uniqueId,
 String taskName,
 WorkflowNextTaskData nextTaskData,
 Attribute[] attributes)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Notifies of a wait event task.

Parameters:

uniqueId - Unique identifier of the workflow process.

taskName - Name of the workflow task.

nextTaskData - Data for the next workflow task.

attributes - Attributes of the workflow process.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setWorkflowProcessNotesById

void setWorkflowProcessNotesById(int processId,
 String notes)
                          throws Exception,
altitude.integrationServer.exceptions.ISException

Sets the workflow process notes.

Parameters:

processId - Identifier of the workflow process.

notes - Notes.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setWorkflowProcessNotesByUniqueId

void setWorkflowProcessNotesByUniqueId(String uniqueId,
 String notes)
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Sets the workflow process notes.

Parameters:

uniqueId - Unique identifier of the workflow process.

notes - Notes.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

startWorkflowProcessById

void startWorkflowProcessById(int processId)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Starts the workflow process.

Parameters:

processId - Identifier of the workflow process.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

startWorkflowProcessByUniqueId

void startWorkflowProcessByUniqueId(String uniqueId)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Starts the workflow process.

Parameters:

uniqueId - Unique identifier of the workflow process.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

suspendWorkflowProcessById

void suspendWorkflowProcessById(int processId)
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Suspends the workflow process.

Parameters:

processId - Identifier of the workflow process.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

suspendWorkflowProcessByUniqueId

void suspendWorkflowProcessByUniqueId(String uniqueId)
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Suspends the workflow process.

Parameters:

uniqueId - Unique identifier of the workflow process.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetWorkflowDefinitionCursor

IWorkflowDefinitionCursor tryGetWorkflowDefinitionCursor(int cursorId)
                                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a workflow definition cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IWorkflowDefinitionCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateWorkflowDefinition

void updateWorkflowDefinition(String definitionName,
 WorkflowDefinitionUpdateRequest request)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a workflow definition.

Parameters:

definitionName - Name of the workflow definition.

request - Contains the fields that can be updated.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateWorkflowTasks

int updateWorkflowTasks(String serviceName,
 String sql,
 WorkflowTaskUpdateRequest request)
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Updates workflow tasks.

Parameters:

serviceName - Name of the service.

sql - SQL.

request - Contains the fields that can be updated.

Returns:

The identifier of the background task created on the Altitude uCI Server.

Throws:

Exception

altitude.integrationServer.exceptions.ISException