com.openkm.sdk4j.impl

Class WorkflowImpl

java.lang.Object

com.openkm.sdk4j.impl.ClientImpl

com.openkm.sdk4j.impl.WorkflowImpl

All Implemented Interfaces:

BaseWorkflow, Serializable

public class WorkflowImpl
extends ClientImpl
implements BaseWorkflow, Serializable

WorkflowImpl

Author:

jllort

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WorkflowImpl(String host) OKMAuth

Method Summary

Modifier and Type	Method and 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() 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() 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(String 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.
void	setAuthorizationToken(String authorizationToken) setAuthenticationToken
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.

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

getClient, resource, resource, resource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowImpl

public WorkflowImpl(String host)

OKMAuth

Method Detail

setAuthorizationToken

public void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

registerProcessDefinition

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

Description copied from interface: BaseWorkflow

Register process definition.

Specified by:

registerProcessDefinition in interface BaseWorkflow

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

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

Description copied from interface: BaseWorkflow

Delete process definition.

Specified by:

deleteProcessDefinition in interface BaseWorkflow

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

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

Description copied from interface: BaseWorkflow

Gets process definition.

Specified by:

getProcessDefinition in interface BaseWorkflow

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

runProcessDefinition

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

Description copied from interface: BaseWorkflow

Run process definition process instance.

Specified by:

runProcessDefinition in interface BaseWorkflow

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

findProcessInstances

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

Description copied from interface: BaseWorkflow

Find process instances list.

Specified by:

findProcessInstances in interface BaseWorkflow

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

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

Description copied from interface: BaseWorkflow

Find all process definitions list.

Specified by:

findAllProcessDefinitions in interface BaseWorkflow

Returns:

the list

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

findLatestProcessDefinitions

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

Description copied from interface: BaseWorkflow

Find latest process definitions list.

Specified by:

findLatestProcessDefinitions in interface BaseWorkflow

Returns:

the list

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

findLastProcessDefinition

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

Description copied from interface: BaseWorkflow

Find last process definition process definition.

Specified by:

findLastProcessDefinition in interface BaseWorkflow

Parameters:

name - the name

Returns:

the process definition

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

getProcessInstance

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

Description copied from interface: BaseWorkflow

Gets process instance.

Specified by:

getProcessInstance in interface BaseWorkflow

Parameters:

piId - the pi id

Returns:

the process instance

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

findUserTaskInstances

public TaskInstanceResultSet findUserTaskInstances()
                                            throws RepositoryException,
                                                   DatabaseException,
                                                   WorkflowException,
                                                   UnknownException,
                                                   WebserviceException,
                                                   AccessDeniedException

Description copied from interface: BaseWorkflow

Find user task instances task instance result set.

Specified by:

findUserTaskInstances in interface BaseWorkflow

Returns:

the task instance result set

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

findTaskInstances

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

Description copied from interface: BaseWorkflow

Find task instances list.

Specified by:

findTaskInstances in interface BaseWorkflow

Parameters:

piId - the pi id

Returns:

the list

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

setTaskInstanceValues

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

Description copied from interface: BaseWorkflow

Sets task instance values.

Specified by:

setTaskInstanceValues in interface BaseWorkflow

Parameters:

pdId - the pd id

tiId - the ti id

tiName - the ti name

transName - the trans name

properties - the properties

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

getTaskInstance

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

Description copied from interface: BaseWorkflow

Gets task instance.

Specified by:

getTaskInstance in interface BaseWorkflow

Parameters:

tiId - the ti id

Returns:

the task instance

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

setTaskInstanceActorId

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

Description copied from interface: BaseWorkflow

Sets task instance actor id.

Specified by:

setTaskInstanceActorId in interface BaseWorkflow

Parameters:

tiId - the ti id

actorId - the actor id

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

startTaskInstance

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

Description copied from interface: BaseWorkflow

Start task instance.

Specified by:

startTaskInstance in interface BaseWorkflow

Parameters:

tiId - the ti id

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

endTaskInstance

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

Description copied from interface: BaseWorkflow

End task instance.

Specified by:

endTaskInstance in interface BaseWorkflow

Parameters:

tiId - the ti id

transName - the trans name

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

getProcessDefinitionForms

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

Description copied from interface: BaseWorkflow

Gets process definition forms.

Specified by:

getProcessDefinitionForms in interface BaseWorkflow

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

getProcessDefinitionImage

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

Description copied from interface: BaseWorkflow

Gets process definition image.

Specified by:

getProcessDefinitionImage in interface BaseWorkflow

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

findPooledTaskInstances

public TaskInstanceResultSet findPooledTaskInstances()
                                              throws RepositoryException,
                                                     DatabaseException,
                                                     WorkflowException,
                                                     UnknownException,
                                                     WebserviceException,
                                                     AccessDeniedException

Description copied from interface: BaseWorkflow

Find pooled task instances task instance result set.

Specified by:

findPooledTaskInstances in interface BaseWorkflow

Returns:

the task instance result set

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

WorkflowException - the workflow exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

findProcessInstancesByNode

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

Description copied from interface: BaseWorkflow

Find process instances list by node

Specified by:

findProcessInstancesByNode in interface BaseWorkflow

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

getSuggestBoxKeyValue

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

Description copied from interface: BaseWorkflow

Gets suggest box key value.

Specified by:

getSuggestBoxKeyValue in interface BaseWorkflow

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

getSuggestBoxKeyValuesFiltered

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

Description copied from interface: BaseWorkflow

Gets suggest box key values filtered.

Specified by:

getSuggestBoxKeyValuesFiltered in interface BaseWorkflow

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