Package com.openkm.sdk4j.definition

Interface BaseWorkflow

All Known Implementing Classes:

WorkflowImpl

public interface BaseWorkflow

BaseWorkflow

Author:

sochoa

Method Summary

Modifier and Type	Method	Description
void	deleteProcessDefinition(long pdId)	Delete process definition.
void	endTaskInstance(long tiId, String transName)	End task instance.
List<ProcessDefinition>	findAllProcessDefinitions()	Find all process definitions list.
ProcessDefinition	findLastProcessDefinition(String name)	Find last process definition process definition.
List<ProcessDefinition>	findLatestProcessDefinitions()	Find latest process definitions list.
TaskInstanceResultSet	findPooledTaskInstances(int offset, int limit)	Find pooled task instances task instance result set.
List<ProcessInstance>	findProcessInstances(long pdId)	Find process instances list.
List<ProcessInstance>	findProcessInstancesByNode(String uuid)	Find process instances list by node
List<TaskInstance>	findTaskInstances(long piId)	Find task instances list.
TaskInstanceResultSet	findUserTaskInstances(int offset, int limit)	Find user task instances task instance result set.
ProcessDefinition	getProcessDefinition(long pdId)	Gets process definition.
Map<String,List<FormElement>>	getProcessDefinitionForms(long pdId)	Gets process definition forms.
String	getProcessDefinitionImage(long pdId, String uuid)	Gets process definition image.
ProcessInstance	getProcessInstance(long piId)	Gets process instance.
String	getSuggestBoxKeyValue(long pdId, String uuid, String taskName, String propertyName, String key)	Gets suggest box key value.
Map<String,String>	getSuggestBoxKeyValuesFiltered(long pdId, String uuid, String taskName, String propertyName, String filter)	Gets suggest box key values filtered.
TaskInstance	getTaskInstance(long tiId)	Gets task instance.
void	registerProcessDefinition(InputStream is)	Register process definition.
ProcessInstance	runProcessDefinition(long pdId, String uuid, Map<String,String> propertiesMap)	Run process definition process instance.
ProcessInstance	runProcessDefinition(long pdId, Map<String,String> propertiesMap)	Run process definition without a node process instance.
ProcessInstanceResultSet	searchAssignedTasks(Calendar start, Calendar end, String status, Long procDefId, int offset, int limit)	Search assigned tasks.
ProcessInstanceResultSet	searchOverview(Calendar start, Calendar end, String status, Long procDefId, String initiator, String taskUser, int offset, int limit)	Search overview.
ProcessInstanceResultSet	searchStartedByMe(Calendar start, Calendar end, String status, Long procDefId, int offset, int limit)	Search started by me.
void	setTaskInstanceActorId(long tiId, String actorId)	Sets task instance actor id.
void	setTaskInstanceValues(long pdId, long tiId, String tiName, String transName, Map<String,String> properties)	Sets task instance values.
void	startTaskInstance(long tiId)	Start task instance.

Method Detail

registerProcessDefinition

void registerProcessDefinition(InputStream is)
                        throws AccessDeniedException,
                               ParseException,
                               RepositoryException,
                               DatabaseException,
                               WorkflowException,
                               UnknownException,
                               WebserviceException

Register process definition.

Parameters:

is - the is

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteProcessDefinition

void deleteProcessDefinition(long pdId)
                      throws AccessDeniedException,
                             RepositoryException,
                             DatabaseException,
                             WorkflowException,
                             UnknownException,
                             WebserviceException

Delete process definition.

Parameters:

pdId - the pd id

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getProcessDefinition

ProcessDefinition getProcessDefinition(long pdId)
                                throws AccessDeniedException,
                                       RepositoryException,
                                       DatabaseException,
                                       WorkflowException,
                                       UnknownException,
                                       WebserviceException

Gets process definition.

Parameters:

pdId - the pd id

Returns:

the process definition

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getProcessDefinitionImage

String getProcessDefinitionImage(long pdId,
                                 String uuid)
                          throws PathNotFoundException,
                                 AccessDeniedException,
                                 ConversionException,
                                 AutomationException,
                                 RepositoryException,
                                 DatabaseException,
                                 UnknownException,
                                 WebserviceException

Gets process definition image.

Parameters:

pdId - the pd id

uuid - the uuid

Returns:

the process definition image

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

ConversionException - the conversion exception

AutomationException - the automation exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

runProcessDefinition

ProcessInstance runProcessDefinition(long pdId,
                                     String uuid,
                                     Map<String,String> propertiesMap)
                              throws WorkflowException,
                                     AccessDeniedException,
                                     RepositoryException,
                                     DatabaseException,
                                     UnknownException,
                                     WebserviceException

Run process definition process instance.

Parameters:

pdId - the pd id

uuid - the uuid

propertiesMap - the properties map

Returns:

the process instance

Throws:

WorkflowException - the workflow exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

runProcessDefinition

ProcessInstance runProcessDefinition(long pdId,
                                     Map<String,String> propertiesMap)
                              throws WorkflowException,
                                     AccessDeniedException,
                                     DatabaseException,
                                     UnknownException,
                                     WebserviceException

Run process definition without a node process instance.

Parameters:

pdId - the pd id

propertiesMap - the properties map

Returns:

the process instance

Throws:

WorkflowException - the workflow exception

AccessDeniedException - the access denied exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findProcessInstances

List<ProcessInstance> findProcessInstances(long pdId)
                                    throws AccessDeniedException,
                                           RepositoryException,
                                           DatabaseException,
                                           WorkflowException,
                                           UnknownException,
                                           WebserviceException

Find process instances list.

Parameters:

pdId - the pd id

Returns:

the list

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findAllProcessDefinitions

List<ProcessDefinition> findAllProcessDefinitions()
                                           throws AccessDeniedException,
                                                  RepositoryException,
                                                  DatabaseException,
                                                  WorkflowException,
                                                  UnknownException,
                                                  WebserviceException

Find all process definitions list.

Returns:

the list

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findLatestProcessDefinitions

List<ProcessDefinition> findLatestProcessDefinitions()
                                              throws AccessDeniedException,
                                                     RepositoryException,
                                                     DatabaseException,
                                                     WorkflowException,
                                                     UnknownException,
                                                     WebserviceException

Find latest process definitions list.

Returns:

the list

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findLastProcessDefinition

ProcessDefinition findLastProcessDefinition(String name)
                                     throws AccessDeniedException,
                                            RepositoryException,
                                            DatabaseException,
                                            WorkflowException,
                                            UnknownException,
                                            WebserviceException

Find last process definition process definition.

Parameters:

name - the name

Returns:

the process definition

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getProcessInstance

ProcessInstance getProcessInstance(long piId)
                            throws AccessDeniedException,
                                   RepositoryException,
                                   DatabaseException,
                                   WorkflowException,
                                   UnknownException,
                                   WebserviceException

Gets process instance.

Parameters:

piId - the pi id

Returns:

the process instance

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findUserTaskInstances

TaskInstanceResultSet findUserTaskInstances(int offset,
                                            int limit)
                                     throws AccessDeniedException,
                                            RepositoryException,
                                            DatabaseException,
                                            WorkflowException,
                                            UnknownException,
                                            WebserviceException

Find user task instances task instance result set.

Parameters:

offset - the offset

limit - the limit

Returns:

the task instance result set

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findTaskInstances

List<TaskInstance> findTaskInstances(long piId)
                              throws AccessDeniedException,
                                     RepositoryException,
                                     DatabaseException,
                                     WorkflowException,
                                     UnknownException,
                                     WebserviceException

Find task instances list.

Parameters:

piId - the pi id

Returns:

the list

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setTaskInstanceValues

void setTaskInstanceValues(long pdId,
                           long tiId,
                           String tiName,
                           String transName,
                           Map<String,String> properties)
                    throws AccessDeniedException,
                           RepositoryException,
                           DatabaseException,
                           WorkflowException,
                           UnknownException,
                           WebserviceException

Sets task instance values.

Parameters:

pdId - the pd id

tiId - the ti id

tiName - the ti name

transName - the trans name

properties - the properties

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getTaskInstance

TaskInstance getTaskInstance(long tiId)
                      throws AccessDeniedException,
                             RepositoryException,
                             DatabaseException,
                             WorkflowException,
                             UnknownException,
                             WebserviceException

Gets task instance.

Parameters:

tiId - the ti id

Returns:

the task instance

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setTaskInstanceActorId

void setTaskInstanceActorId(long tiId,
                            String actorId)
                     throws AccessDeniedException,
                            RepositoryException,
                            DatabaseException,
                            WorkflowException,
                            UnknownException,
                            WebserviceException

Sets task instance actor id.

Parameters:

tiId - the ti id

actorId - the actor id

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

startTaskInstance

void startTaskInstance(long tiId)
                throws AccessDeniedException,
                       RepositoryException,
                       DatabaseException,
                       WorkflowException,
                       UnknownException,
                       WebserviceException

Start task instance.

Parameters:

tiId - the ti id

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

endTaskInstance

void endTaskInstance(long tiId,
                     String transName)
              throws AccessDeniedException,
                     RepositoryException,
                     DatabaseException,
                     WorkflowException,
                     UnknownException,
                     WebserviceException

End task instance.

Parameters:

tiId - the ti id

transName - the trans name

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getProcessDefinitionForms

Map<String,List<FormElement>> getProcessDefinitionForms(long pdId)
                                                       throws ParseException,
                                                              AccessDeniedException,
                                                              RepositoryException,
                                                              DatabaseException,
                                                              WorkflowException,
                                                              UnknownException,
                                                              WebserviceException

Gets process definition forms.

Parameters:

pdId - the pd id

Returns:

the process definition forms

Throws:

ParseException - the parse exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getSuggestBoxKeyValuesFiltered

Map<String,String> getSuggestBoxKeyValuesFiltered(long pdId,
                                                        String uuid,
                                                        String taskName,
                                                        String propertyName,
                                                        String filter)
                                                 throws ParseException,
                                                        AccessDeniedException,
                                                        DatabaseException,
                                                        PluginNotFoundException,
                                                        UnknownException,
                                                        WebserviceException

Gets suggest box key values filtered.

Parameters:

pdId - the pd id

uuid - the uuid

taskName - the task name

propertyName - the property name

filter - the filter

Returns:

the suggest box key values filtered

Throws:

ParseException - the parse exception

AccessDeniedException - the access denied exception

DatabaseException - the database exception

PluginNotFoundException - the plugin not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getSuggestBoxKeyValue

String getSuggestBoxKeyValue(long pdId,
                             String uuid,
                             String taskName,
                             String propertyName,
                             String key)
                      throws ParseException,
                             AccessDeniedException,
                             DatabaseException,
                             PluginNotFoundException,
                             UnknownException,
                             WebserviceException

Gets suggest box key value.

Parameters:

pdId - the pd id

uuid - the uuid

taskName - the task name

propertyName - the property name

key - the key

Returns:

the suggest box key value

Throws:

ParseException - the parse exception

AccessDeniedException - the access denied exception

DatabaseException - the database exception

PluginNotFoundException - the plugin not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findPooledTaskInstances

TaskInstanceResultSet findPooledTaskInstances(int offset,
                                              int limit)
                                       throws AccessDeniedException,
                                              RepositoryException,
                                              DatabaseException,
                                              WorkflowException,
                                              UnknownException,
                                              WebserviceException

Find pooled task instances task instance result set.

Parameters:

offset - the offset

limit - the limit

Returns:

the task instance result set

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findProcessInstancesByNode

List<ProcessInstance> findProcessInstancesByNode(String uuid)
                                          throws AccessDeniedException,
                                                 RepositoryException,
                                                 DatabaseException,
                                                 WorkflowException,
                                                 UnknownException,
                                                 WebserviceException

Find process instances list by node

Parameters:

uuid - the uuid

Returns:

the list

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

searchAssignedTasks

ProcessInstanceResultSet searchAssignedTasks(Calendar start,
                                             Calendar end,
                                             String status,
                                             Long procDefId,
                                             int offset,
                                             int limit)
                                      throws AccessDeniedException,
                                             RepositoryException,
                                             DatabaseException,
                                             WorkflowException,
                                             UnknownException,
                                             WebserviceException

Search assigned tasks.

Parameters:

start - the start date

end - the end date

status - the status

procDefId - the process definition id

offset - the offset

limit - the limit

Returns:

the process instance result set

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

searchStartedByMe

ProcessInstanceResultSet searchStartedByMe(Calendar start,
                                           Calendar end,
                                           String status,
                                           Long procDefId,
                                           int offset,
                                           int limit)
                                    throws AccessDeniedException,
                                           RepositoryException,
                                           DatabaseException,
                                           WorkflowException,
                                           UnknownException,
                                           WebserviceException

Search started by me.

Parameters:

start - the start date

end - the end date

status - the status

procDefId - the process definition id

offset - the offset

limit - the limit

Returns:

the process instance result set

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

searchOverview

ProcessInstanceResultSet searchOverview(Calendar start,
                                        Calendar end,
                                        String status,
                                        Long procDefId,
                                        String initiator,
                                        String taskUser,
                                        int offset,
                                        int limit)
                                 throws AccessDeniedException,
                                        RepositoryException,
                                        DatabaseException,
                                        WorkflowException,
                                        UnknownException,
                                        WebserviceException

Search overview.

Parameters:

start - the start date

end - the end date

status - the status

procDefId - the process definition id

initiator - the initiator

taskUser - the task user

offset - the offset

limit - the limit

Returns:

the process instance result set

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception