com.saperion.connector.workflow

Class RmiClientWorkflowDefinitionService

java.lang.Object

com.saperion.connector.workflow.RmiClientWorkflowDefinitionService

All Implemented Interfaces:

WorkflowDefinitionService

public class RmiClientWorkflowDefinitionService
extends Object
implements WorkflowDefinitionService

This WorkflowDefinitionService provides workflow definition functionality by simply delegating by RMI.

Author:

jschwarz

Constructor Summary

Constructors

Constructor and Description
RmiClientWorkflowDefinitionService(Connection connection)

Method Summary

Methods

Modifier and Type	Method and Description
com.lexmark.saperion.workflow.TransitionDefinitionType	getInitialTransition(com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType reference) This method returns the initial transition definition for the referenced workflow.
com.lexmark.saperion.workflow.WorkflowDefinitionType	getWorkflowDefinitionById(com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType id) This method returns further information for a workflow process given by its reference.
List<com.lexmark.saperion.workflow.WorkflowDefinitionListItemType>	listWorkflowDefinitions() This method returns a list of references for every workflow definition in the system accessible from the current tenant.
com.lexmark.saperion.workflow.WorkflowProcessReferenceType	startWorkflowProcess(com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType workflowDefinitionReference, com.lexmark.saperion.document.DocumentReferenceType documentId, List<? extends com.lexmark.saperion.administration.ActorReferenceType> actors, String comment) This method starts a workflow process given a workflow definition and a document (by its id).

Methods inherited from class java.lang.Object

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

Constructor Detail

RmiClientWorkflowDefinitionService

public RmiClientWorkflowDefinitionService(Connection connection)

Method Detail

listWorkflowDefinitions

public List<com.lexmark.saperion.workflow.WorkflowDefinitionListItemType> listWorkflowDefinitions()
                                                                                           throws SaAuthenticationException,
                                                                                                  NativeException

Description copied from interface: WorkflowDefinitionService

This method returns a list of references for every workflow definition in the system accessible from the current tenant.

Specified by:

listWorkflowDefinitions in interface WorkflowDefinitionService

Returns:

a list of every workflow definition in the system accessible from the current tenant

Throws:

SaAuthenticationException

NativeException

getInitialTransition

public com.lexmark.saperion.workflow.TransitionDefinitionType getInitialTransition(com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType reference)
                                                                            throws SaBasicException

Description copied from interface: WorkflowDefinitionService

This method returns the initial transition definition for the referenced workflow. If the referenced workflow definition doesn't exist the method throws an UnknownReferenceException. If the initial transition was not found the method returns null.

Specified by:

getInitialTransition in interface WorkflowDefinitionService

Parameters:

reference - the workflow definition reference

Returns:

the initial transition of the referenced workflow or null if not present

Throws:

UnknownReferenceException - the referenced workflow definition does not exist

SaBasicException

getWorkflowDefinitionById

public com.lexmark.saperion.workflow.WorkflowDefinitionType getWorkflowDefinitionById(com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType id)
                                                                               throws NativeException,
                                                                                      UnknownReferenceException,
                                                                                      MalformedEntityException,
                                                                                      SaAuthenticationException

Description copied from interface: WorkflowDefinitionService

This method returns further information for a workflow process given by its reference.

Specified by:

getWorkflowDefinitionById in interface WorkflowDefinitionService

Parameters:

id - a reference of the workflow process to obtain the information for

Returns:

further information for a workflow process given by its reference

Throws:

NativeException

UnknownReferenceException

MalformedEntityException

SaAuthenticationException

startWorkflowProcess

public com.lexmark.saperion.workflow.WorkflowProcessReferenceType startWorkflowProcess(com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType workflowDefinitionReference,
                                                                              com.lexmark.saperion.document.DocumentReferenceType documentId,
                                                                              List<? extends com.lexmark.saperion.administration.ActorReferenceType> actors,
                                                                              String comment)
                                                                                throws SaBasicException

Description copied from interface: WorkflowDefinitionService

This method starts a workflow process given a workflow definition and a document (by its id).

Specified by:

startWorkflowProcess in interface WorkflowDefinitionService

Parameters:

workflowDefinitionReference - a reference to the workflow definition to start

documentId - the id of the document to start the process on

actors - a list of the receivers of the next task, may be null depending on the workflow definition

comment - a comment for the workflow process, may be null depending on the workflow definition

Returns:

a reference to the process that was started.

Throws:

SaBasicException