Package com.saperion.ngc.model.workflow

Interface WorkflowService

All Superinterfaces:

Service

All Known Implementing Classes:

WorkflowConnectorService

public interface WorkflowService
extends Service

Author:

tfr

Method Summary

Modifier and Type	Method	Description
com.saperion.connector.wf.WorkflowResult	addComment(java.lang.String taskId, java.lang.String comment)	Execute add comment.
com.saperion.connector.wf.WorkflowResult	addHistory(java.lang.String taskId, java.lang.String description)	Execute set history.
com.saperion.connector.wf.WorkflowResult	executeActivate(java.lang.String taskId)	Execute activate.
com.saperion.connector.wf.WorkflowResult	executeApprove(java.lang.String taskId, java.lang.String nextUser)	Execute delegate.
com.saperion.connector.wf.WorkflowResult	executeAssignToMe(java.lang.String taskId)	Execute AssignToMe.
com.saperion.connector.wf.WorkflowResult	executeChangeOwner(java.lang.String taskId, java.lang.String newOwner)	Execute change owner.
com.saperion.connector.wf.WorkflowResult	executeCommand(WorkflowActionBean workflowAction)	Execute the given command.
com.saperion.connector.wf.WorkflowResult	executeDelegate(java.lang.String taskId, java.lang.String delegatee)	Execute delegate.
com.saperion.connector.wf.WorkflowResult	executeEscalation(java.lang.String taskId, java.util.Date date)	Execute escalate.
com.saperion.connector.wf.WorkflowResult	executeForward(java.lang.String taskId, java.lang.String nextUser, int transition)	Execute forward.
com.saperion.connector.wf.WorkflowResult	executeHold(java.lang.String taskId, java.util.Date date)	Execute hold.
com.saperion.connector.wf.WorkflowResult	executeInactivate(java.lang.String taskId)	Execute inactivate.
com.saperion.connector.wf.WorkflowResult	executeNotResponsible(java.lang.String taskId, java.lang.String comment)	Execute not responsible.
com.saperion.connector.wf.WorkflowResult	executePutBack(java.lang.String taskId)	Execute putback.
com.saperion.connector.wf.WorkflowResult	executeReassign(java.lang.String taskId)	Execute reassign.
com.saperion.connector.wf.WorkflowResult	executeReject(java.lang.String taskId, java.lang.String nextUser)	Execute reject.
com.saperion.connector.wf.WorkflowResult	executeRemove(java.lang.String taskId, java.lang.String comment)	Execute remove.
com.saperion.connector.wf.WorkflowResult	executeRemoveNotice(java.lang.String taskId)	Execute remove notice.
com.saperion.connector.wf.WorkflowResult	executeResetHold(java.lang.String taskId)	Execute reset hold.
com.saperion.connector.wf.WorkflowResult	executeRework(java.lang.String taskId, java.lang.String nextUser)	Execute rework.
com.saperion.connector.wf.WorkflowResult	executeSetActivity(java.lang.String taskId, int activity)	Execute set activity.
com.saperion.connector.wf.WorkflowResult	executeTake(java.lang.String taskId)	Execute take.
com.saperion.connector.wf.WorkflowResult	executeTerminate(java.lang.String taskId)	Execute terminate.
java.util.List<com.saperion.intf.wf.CommentInfo>	getComments(com.saperion.intf.wf.TaskInfo task)	Retrieves the comments for the specified task.
java.util.List<java.lang.String>	getDefinitions()	Reads the available workflow definitions.
java.util.List<com.saperion.wf.ProcessDefinitionDescriptor>	getDefinitions(java.lang.String ddcName)	Reads the available workflow definitions for the specified DDC.
java.util.List<com.saperion.intf.wf.HistoryInfo[]>	getDocHistories(java.lang.String docHdoc)	Reads history information for a given document.
com.saperion.intf.wf.BoxDefinition	getInboxDefinition()	Retrieves the definition of the current user's inbox.
com.saperion.intf.wf.WorkflowMember	getMember(com.saperion.intf.wf.WorkflowMember member, int depth, java.lang.String filter)	Reads direct workflow member.
com.saperion.intf.wf.WorkflowMember	getMembers()	Reads workflow member.
java.lang.String	getSubstitute()	Gets the fullname of the substitute for workflows of the current user.
com.saperion.jcs.modules.users.api.User	getSubstituteUser()	Gets the substitute-user for the current user.
com.saperion.connector.wf.SaWFTask	getTask(java.lang.String taskId)	Load the task object.
java.lang.String	getWfDisplayName(com.saperion.intf.wf.WorkflowMember member)	Retrieves the comments for the specified task.
boolean	isWorkflowFeatureEnabled()	Checks if the workflow-feature is enabled.
com.saperion.connector.wf.WorkflowResult	setComment(java.lang.String taskId, java.lang.String comment)	Execute set comment.
void	setSubstitute(java.lang.String substituteFullname)	Sets the substitute for workflows.
com.saperion.connector.wf.WorkflowResult	startWorkflow(java.lang.String definition, java.lang.String actor, java.lang.String comment, java.lang.String attachmentUID)	Execute start workflow.

Methods inherited from interface com.saperion.ngc.model.Service

isActive

Method Detail

getDefinitions

java.util.List<java.lang.String> getDefinitions()
                                         throws AuthenticationException,
                                                SystemException,
                                                WorkflowException

Reads the available workflow definitions.

Returns:

Workflow definitions

Throws:

WorkflowException - workflow exception

SystemException - system exception

AuthenticationException - authentication exception

getDefinitions

java.util.List<com.saperion.wf.ProcessDefinitionDescriptor> getDefinitions(java.lang.String ddcName)
                                                                    throws AuthenticationException,
                                                                           SystemException,
                                                                           WorkflowException

Reads the available workflow definitions for the specified DDC. If the usage of workflow definitions is not restricted, all definitions will be returned.

Parameters:

ddcName - name of the DDC

Returns:

Workflow definitions

Throws:

WorkflowException - workflow exception

SystemException - system exception

AuthenticationException - authentication exception

getMember

com.saperion.intf.wf.WorkflowMember getMember(com.saperion.intf.wf.WorkflowMember member,
                                              int depth,
                                              java.lang.String filter)
                                       throws WorkflowException,
                                              SystemException

Reads direct workflow member.

Parameters:

member - workflow member, witch direct children will be returned

depth - depth of the returned children.

filter - filter string

Returns:

Member tree

Throws:

WorkflowException - workflow exception

SystemException - system exception

getMembers

com.saperion.intf.wf.WorkflowMember getMembers()
                                        throws WorkflowException,
                                               SystemException

Reads workflow member.

Returns:

Member tree

Throws:

SystemException - system exception

WorkflowException - workflow exception

executeCommand

com.saperion.connector.wf.WorkflowResult executeCommand(WorkflowActionBean workflowAction)
                                                 throws WorkflowException

Execute the given command. The parameters must fit to the given command. Unneeded parameters can be set to null.

Parameters:

workflowAction - Information needed for executing workflow command

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeApprove

com.saperion.connector.wf.WorkflowResult executeApprove(java.lang.String taskId,
                                                        java.lang.String nextUser)
                                                 throws WorkflowException

Execute delegate.

Parameters:

taskId - Task ID

nextUser - Next user

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeForward

com.saperion.connector.wf.WorkflowResult executeForward(java.lang.String taskId,
                                                        java.lang.String nextUser,
                                                        int transition)
                                                 throws WorkflowException

Execute forward.

Parameters:

taskId - Task ID

nextUser - Next user

transition - Transition

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeReject

com.saperion.connector.wf.WorkflowResult executeReject(java.lang.String taskId,
                                                       java.lang.String nextUser)
                                                throws WorkflowException

Execute reject.

Parameters:

taskId - Task ID

nextUser - Next user

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeRework

com.saperion.connector.wf.WorkflowResult executeRework(java.lang.String taskId,
                                                       java.lang.String nextUser)
                                                throws WorkflowException

Execute rework.

Parameters:

taskId - Task ID

nextUser - Next user

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeNotResponsible

com.saperion.connector.wf.WorkflowResult executeNotResponsible(java.lang.String taskId,
                                                               java.lang.String comment)
                                                        throws WorkflowException

Execute not responsible.

Parameters:

taskId - Task ID

comment - Comment

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeTake

com.saperion.connector.wf.WorkflowResult executeTake(java.lang.String taskId)
                                              throws WorkflowException

Execute take.

Parameters:

taskId - Task ID

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeRemove

com.saperion.connector.wf.WorkflowResult executeRemove(java.lang.String taskId,
                                                       java.lang.String comment)
                                                throws WorkflowException

Execute remove.

Parameters:

taskId - Task ID

comment - Comment

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeRemoveNotice

com.saperion.connector.wf.WorkflowResult executeRemoveNotice(java.lang.String taskId)
                                                      throws WorkflowException

Execute remove notice.

Parameters:

taskId - Task ID

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeHold

com.saperion.connector.wf.WorkflowResult executeHold(java.lang.String taskId,
                                                     java.util.Date date)
                                              throws WorkflowException

Execute hold.

Parameters:

taskId - Task ID

date - Hold date

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeResetHold

com.saperion.connector.wf.WorkflowResult executeResetHold(java.lang.String taskId)
                                                   throws WorkflowException

Execute reset hold.

Parameters:

taskId - Task ID

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeEscalation

com.saperion.connector.wf.WorkflowResult executeEscalation(java.lang.String taskId,
                                                           java.util.Date date)
                                                    throws WorkflowException

Execute escalate.

Parameters:

taskId - Task ID

date - Escalation date

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeInactivate

com.saperion.connector.wf.WorkflowResult executeInactivate(java.lang.String taskId)
                                                    throws WorkflowException

Execute inactivate.

Parameters:

taskId - Task ID

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeActivate

com.saperion.connector.wf.WorkflowResult executeActivate(java.lang.String taskId)
                                                  throws WorkflowException

Execute activate.

Parameters:

taskId - Task ID

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeTerminate

com.saperion.connector.wf.WorkflowResult executeTerminate(java.lang.String taskId)
                                                   throws WorkflowException

Execute terminate.

Parameters:

taskId - Task ID

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeChangeOwner

com.saperion.connector.wf.WorkflowResult executeChangeOwner(java.lang.String taskId,
                                                            java.lang.String newOwner)
                                                     throws WorkflowException

Execute change owner.

Parameters:

taskId - Task ID

newOwner - New owner

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeSetActivity

com.saperion.connector.wf.WorkflowResult executeSetActivity(java.lang.String taskId,
                                                            int activity)
                                                     throws WorkflowException

Execute set activity.

Parameters:

taskId - Task ID

activity - Activity

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeDelegate

com.saperion.connector.wf.WorkflowResult executeDelegate(java.lang.String taskId,
                                                         java.lang.String delegatee)
                                                  throws WorkflowException

Execute delegate.

Parameters:

taskId - Task ID

delegatee - Delegatee

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeReassign

com.saperion.connector.wf.WorkflowResult executeReassign(java.lang.String taskId)
                                                  throws WorkflowException

Execute reassign.

Parameters:

taskId - Task ID

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executeAssignToMe

com.saperion.connector.wf.WorkflowResult executeAssignToMe(java.lang.String taskId)
                                                    throws WorkflowException

Execute AssignToMe.

Parameters:

taskId - Task ID

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

executePutBack

com.saperion.connector.wf.WorkflowResult executePutBack(java.lang.String taskId)
                                                 throws WorkflowException

Execute putback.

Parameters:

taskId - Task ID

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

setComment

com.saperion.connector.wf.WorkflowResult setComment(java.lang.String taskId,
                                                    java.lang.String comment)
                                             throws WorkflowException

Execute set comment.

Parameters:

taskId - Task ID

comment - Comment

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

addComment

com.saperion.connector.wf.WorkflowResult addComment(java.lang.String taskId,
                                                    java.lang.String comment)
                                             throws WorkflowException

Execute add comment.

Parameters:

taskId - Task ID

comment - Comment

Returns:

Workflow result

Throws:

WorkflowException - workflow exception

addHistory

com.saperion.connector.wf.WorkflowResult addHistory(java.lang.String taskId,
                                                    java.lang.String description)
                                             throws WorkflowException,
                                                    SystemException,
                                                    AuthenticationException

Execute set history.

Parameters:

taskId - Task ID

description - Description

Returns:

Workflow result

Throws:

SystemException - system exception

WorkflowException - workflow exception

AuthenticationException - authentication exception

startWorkflow

com.saperion.connector.wf.WorkflowResult startWorkflow(java.lang.String definition,
                                                       java.lang.String actor,
                                                       java.lang.String comment,
                                                       java.lang.String attachmentUID)
                                                throws WorkflowException

Execute start workflow.

Parameters:

definition - Definition name

actor - Actor

comment - Comment

attachmentUID - Attachment UID

Returns:

True, if done

Throws:

WorkflowException - workflow exception

getTask

com.saperion.connector.wf.SaWFTask getTask(java.lang.String taskId)
                                    throws AuthenticationException,
                                           SystemException,
                                           WorkflowException

Load the task object.

Parameters:

taskId - task id

Returns:

task

Throws:

WorkflowException - workflow exception

SystemException - system exception

AuthenticationException - authentication exception

getDocHistories

java.util.List<com.saperion.intf.wf.HistoryInfo[]> getDocHistories(java.lang.String docHdoc)
                                                            throws WorkflowException

Reads history information for a given document.

Parameters:

docHdoc - document's hDoc

Returns:

list of history information arrays

Throws:

WorkflowException - workflow exception

getComments

java.util.List<com.saperion.intf.wf.CommentInfo> getComments(com.saperion.intf.wf.TaskInfo task)
                                                      throws AuthenticationException,
                                                             SystemException,
                                                             WorkflowException

Retrieves the comments for the specified task.

Parameters:

task - task

Returns:

list of comments

Throws:

AuthenticationException - authentication exception

SystemException - system exception

WorkflowException - workflow exception

getWfDisplayName

java.lang.String getWfDisplayName(com.saperion.intf.wf.WorkflowMember member)

Retrieves the comments for the specified task.

Parameters:

member - member to get display name for

Returns:

display name

getInboxDefinition

com.saperion.intf.wf.BoxDefinition getInboxDefinition()
                                               throws AuthenticationException,
                                                      SystemException

Retrieves the definition of the current user's inbox.

Returns:

BoxDefinition for user's inbox

Throws:

AuthenticationException - authentication exception

SystemException - system exception

isWorkflowFeatureEnabled

boolean isWorkflowFeatureEnabled()
                          throws SystemException

Checks if the workflow-feature is enabled.

Returns:

true, if workflow-feature is enabled

Throws:

SystemException - system exception when checking feature

getSubstitute

java.lang.String getSubstitute()
                        throws AuthenticationException,
                               SystemException

Gets the fullname of the substitute for workflows of the current user.

Returns:

Fullname of the substitute user.

Throws:

AuthenticationException - Authentication exception

SystemException - system exception

getSubstituteUser

com.saperion.jcs.modules.users.api.User getSubstituteUser()
                                                   throws AuthenticationException,
                                                          SystemException

Gets the substitute-user for the current user.

Returns:

the substitute user or null if no substitute user is available

Throws:

AuthenticationException - authentication exception

SystemException - system exception

setSubstitute

void setSubstitute(java.lang.String substituteFullname)
            throws AuthenticationException,
                   SystemException

Sets the substitute for workflows.

Parameters:

substituteFullname - Fullname of the substitute to store.

Throws:

AuthenticationException - Authentication exception

SystemException - system exception