com.saperion.connector.wf

Class SaWFTaskImpl

java.lang.Object

com.saperion.connector.wf.SaWFTaskImpl

All Implemented Interfaces:

SaWFTask

public class SaWFTaskImpl
extends Object
implements SaWFTask

Implementation of the @link SaWFTask interface.
Implements the handling of all step related tasks for a TaskInfo

Author:

rbo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SaWFTaskImpl(SaClassicConnectorImpl connector, TaskInfo taskInfo, String user) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addComment(String commentString, int level) Adds a comment to the workflow.
void	addHistory(String descriptionString) Adds a history entry.
void	executeActivate() Set inactive process to active.
void	executeApprove(ActorInfo nextActor) Approve step.
void	executeAssignToMe() Get task from absent user, the current user acts as substitute for.
void	executeChangeOwner(ActorInfo newOwner) Change process owner.
void	executeCommand(CommandInfo command, String processName, ActorInfo nextActor, String commentString, Date escalationDate, int activity) Performs the given command.
void	executeDelegate(ActorInfo delegatee) Delegate to user.
void	executeEscalation(Date escalationDate) Escalate step.
void	executeForward(int transitionId, ActorInfo nextActor) Forward step.
void	executeForward(int transitionId, ActorInfo nextActor, String reason) Forward step.
void	executeHold(Date holdDate) Set step to hold.
void	executeInactivate() Set step to inactive.
void	executeNotResponsible(String commentString) Not responsible for this step.
void	executePutBack() Put step back to inbox.
void	executeReassign() Reassign task to original user after it has been taken as a substitute.
void	executeReject(ActorInfo nextActor) Reject step.
void	executeRemove(String removeComment) Remove step.
void	executeRemoveNotice() Remove notice.
void	executeResetHold() Resets hold.
void	executeRework(ActorInfo nextActor) Rework step.
void	executeSetActivity(int activity) Set next activity.
void	executeTake() Take step from task list.
void	executeTerminate() Terminate process.
InputStream	getAttachmentContent(int element) Reads the content of the attachment.
CommandInfo[]	getCommandInfos() Reads all possible transitions for this task.
CommandInfo[]	getCommandInfos(boolean transitionsOnly) Reads all possible transitions and optional other possible commands for this task.
CommentInfo[]	getComments() Reads the comments.
HistoryInfo[]	getHistory() Reads the process history.
String	getHistoryXML() Reads the process history as XML.
String	getHistoryXML(String language) Reads the process history as XML.
String	getHistoryXML2(String language) Reads the second variant of process history as XML.
String	getHistoryXML2(String language, boolean isAscending) Reads the second variant of process history as XML with ascending / descending switch.
boolean	getSync() Reads the sync status.
TaskInfo	getTaskInfo() Reads the task info object of this task.
boolean	getTrusted() Reads the trusted status.
int	getWorkingTime()
SaPropertyValue[]	readAttachmentMetadata() Reads the metadata of the attachment.
TaskUserSelection	readSelectableUsersForTransition(int transition) Obtains the next tasks TaskUserSelection for the given transition.
void	setAlias(ActorInfo alias) Sets the actor to be used as alias for the next action.
void	setAliasActor(ActorInfo aliasActor) Sets the alias actor.
void	setComment(String commentString) Set comment to the next execute.
void	setSync(boolean isSync) Set sync parameter.
void	setTrusted(boolean isTrusted) Set trusted parameter.
void	setWorkingTime(int time)
SaSaveInfo	updateAttachment(Properties namevaluePairs, InputStream[] content, String versionComment, String acls) Updates the attachment in the backend system with the given metadata, acls and content.
void	updateTask(Properties values) Updates the user defined fields of this task.

Methods inherited from class java.lang.Object

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

Constructor Detail

SaWFTaskImpl

protected SaWFTaskImpl(SaClassicConnectorImpl connector,
            TaskInfo taskInfo,
            String user)
                throws SaAuthenticationException,
                       SaSystemException,
                       SaWorkflowException

Constructor.

Parameters:

connector - Connector instance

taskInfo - Task info

user - User name

Throws:

SaWorkflowException - Workflow exception

SaSystemException - System exception

SaAuthenticationException - Authentication exception

Method Detail

executeApprove

public void executeApprove(ActorInfo nextActor)
                    throws SaWorkflowException

Approve step.

Specified by:

executeApprove in interface SaWFTask

Parameters:

nextActor - Next actor

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeApprove(com.saperion.intf.wf.ActorInfo)

executeChangeOwner

public void executeChangeOwner(ActorInfo newOwner)
                        throws SaWorkflowException

Change process owner.

Specified by:

executeChangeOwner in interface SaWFTask

Parameters:

newOwner - New owner

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeChangeOwner(com.saperion.intf.wf.ActorInfo)

executeCommand

public void executeCommand(CommandInfo command,
                  String processName,
                  ActorInfo nextActor,
                  String commentString,
                  Date escalationDate,
                  int activity)
                    throws SaWorkflowException

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

Specified by:

executeCommand in interface SaWFTask

Parameters:

command - Required. Command object.

processName - Optional. Process definition name.

nextActor - Optional. Next actor / delegatee

commentString - Optional. Comment

escalationDate - Optional. Escalation date

activity - Optional. Activity

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeCommand(com.saperion.intf.wf.CommandInfo, java.lang.String, com.saperion.intf.wf.ActorInfo, java.lang.String, java.util.Date, int)

executeDelegate

public void executeDelegate(ActorInfo delegatee)
                     throws SaWorkflowException

Delegate to user.

Specified by:

executeDelegate in interface SaWFTask

Parameters:

delegatee - Delegatee

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeDelegate(com.saperion.intf.wf.ActorInfo)

executeReassign

public void executeReassign()
                     throws SaWorkflowException

Reassign task to original user after it has been taken as a substitute.

Specified by:

executeReassign in interface SaWFTask

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeReassign()

executeAssignToMe

public void executeAssignToMe()
                       throws SaWorkflowException

Get task from absent user, the current user acts as substitute for.

Specified by:

executeAssignToMe in interface SaWFTask

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeDelegate(com.saperion.intf.wf.ActorInfo)

executeEscalation

public void executeEscalation(Date escalationDate)
                       throws SaWorkflowException

Escalate step.

Specified by:

executeEscalation in interface SaWFTask

Parameters:

escalationDate - Escalation date

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeEscalation(java.util.Date)

executeForward

public void executeForward(int transitionId,
                  ActorInfo nextActor)
                    throws SaWorkflowException

Forward step.

Specified by:

executeForward in interface SaWFTask

Parameters:

transitionId - Transition ID

nextActor - Next actor

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeForward(int, com.saperion.intf.wf.ActorInfo)

executeForward

public void executeForward(int transitionId,
                  ActorInfo nextActor,
                  String reason)
                    throws SaWorkflowException

Forward step.

Specified by:

executeForward in interface SaWFTask

Parameters:

transitionId - Transition ID

nextActor - Next actor

reason - reason for forward

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeForward(int, com.saperion.intf.wf.ActorInfo, String)

executeHold

public void executeHold(Date holdDate)
                 throws SaWorkflowException

Set step to hold.

Specified by:

executeHold in interface SaWFTask

Parameters:

holdDate - Hold date

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeHold(java.util.Date)

executeResetHold

public void executeResetHold()
                      throws SaWorkflowException

Resets hold.

Specified by:

executeResetHold in interface SaWFTask

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeResetHold()

executeNotResponsible

public void executeNotResponsible(String commentString)
                           throws SaWorkflowException

Not responsible for this step.

Specified by:

executeNotResponsible in interface SaWFTask

Parameters:

commentString - Comment

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeNotResponsible(java.lang.String)

executePutBack

public void executePutBack()
                    throws SaWorkflowException

Put step back to inbox.

Specified by:

executePutBack in interface SaWFTask

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executePutBack()

executeReject

public void executeReject(ActorInfo nextActor)
                   throws SaWorkflowException

Reject step.

Specified by:

executeReject in interface SaWFTask

Parameters:

nextActor - Reject actor

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeReject(com.saperion.intf.wf.ActorInfo)

executeRemove

public void executeRemove(String removeComment)
                   throws SaWorkflowException

Remove step.

Specified by:

executeRemove in interface SaWFTask

Parameters:

removeComment - Comment

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeRemove(java.lang.String)

executeRemoveNotice

public void executeRemoveNotice()
                         throws SaWorkflowException

Remove notice.

Specified by:

executeRemoveNotice in interface SaWFTask

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeRemoveNotice()

executeRework

public void executeRework(ActorInfo nextActor)
                   throws SaWorkflowException

Rework step.

Specified by:

executeRework in interface SaWFTask

Parameters:

nextActor - Rework actor

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeRework(com.saperion.intf.wf.ActorInfo)

executeActivate

public void executeActivate()
                     throws SaWorkflowException

Set inactive process to active.

Specified by:

executeActivate in interface SaWFTask

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeActivate()

executeSetActivity

public void executeSetActivity(int activity)
                        throws SaWorkflowException

Set next activity.

Specified by:

executeSetActivity in interface SaWFTask

Parameters:

activity - Activity ID

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeSetActivity(int)

executeTake

public void executeTake()
                 throws SaWorkflowException

Take step from task list.

Specified by:

executeTake in interface SaWFTask

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeTake()

executeTerminate

public void executeTerminate()
                      throws SaWorkflowException

Terminate process.

Specified by:

executeTerminate in interface SaWFTask

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeTerminate()

executeInactivate

public void executeInactivate()
                       throws SaWorkflowException

Set step to inactive.

Specified by:

executeInactivate in interface SaWFTask

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.executeInactivate()

getAttachmentContent

public InputStream getAttachmentContent(int element)
                                 throws SaSystemException,
                                        SaAuthenticationException,
                                        SaWorkflowException

Reads the content of the attachment.

Specified by:

getAttachmentContent in interface SaWFTask

Parameters:

element - position in the document structure; 0 if the document is unstructured.

Returns:

Content stream of base document

Throws:

SaSystemException - SaSystemException

SaAuthenticationException - SaAuthenticationException

SaWorkflowException - Workflow exception

See Also:

SaWFTask.getAttachmentContent(int)

getCommandInfos

public CommandInfo[] getCommandInfos()
                              throws SaAuthenticationException,
                                     SaSystemException,
                                     SaWorkflowException

Reads all possible transitions for this task.

Specified by:

getCommandInfos in interface SaWFTask

Returns:

Command list

Throws:

SaAuthenticationException - Authentication exception

SaSystemException - System exception

SaWorkflowException - Workflow exception

See Also:

SaWFTask.getCommandInfos()

getCommandInfos

public CommandInfo[] getCommandInfos(boolean transitionsOnly)
                              throws SaAuthenticationException,
                                     SaSystemException,
                                     SaWorkflowException

Reads all possible transitions and optional other possible commands for this task.

Specified by:

getCommandInfos in interface SaWFTask

Parameters:

transitionsOnly - if true, only transition commands will be returned

Returns:

Command list

Throws:

SaAuthenticationException - Authentication exception

SaSystemException - System exception

SaWorkflowException - Workflow exception

See Also:

SaWFTask.getCommandInfos(boolean)

readSelectableUsersForTransition

public TaskUserSelection readSelectableUsersForTransition(int transition)
                                                   throws SaAuthenticationException,
                                                          SaSystemException,
                                                          SaWorkflowException

Obtains the next tasks TaskUserSelection for the given transition.

Specified by:

readSelectableUsersForTransition in interface SaWFTask

Parameters:

transition - The id of the transition one wants to obtain the user selection from.

Returns:

The next tasks TaskUserSelection for the given transition.

Throws:

SaAuthenticationException - if the session is not valid anymore

SaSystemException - if an error occurred on the server

SaWorkflowException - if a workflow specific error occurred

getComments

public CommentInfo[] getComments()
                          throws SaWorkflowException

Reads the comments.

Specified by:

getComments in interface SaWFTask

Returns:

Array of comment objects

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.getComments()

getHistory

public HistoryInfo[] getHistory()
                         throws SaWorkflowException

Reads the process history.

Specified by:

getHistory in interface SaWFTask

Returns:

List of history objects

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.getHistory()

getHistoryXML

public String getHistoryXML()
                     throws SaWorkflowException

Reads the process history as XML.

Specified by:

getHistoryXML in interface SaWFTask

Returns:

XML string of history objects

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.getHistoryXML()

getHistoryXML

public String getHistoryXML(String language)
                     throws SaWorkflowException

Reads the process history as XML.

Specified by:

getHistoryXML in interface SaWFTask

Parameters:

language - Language

Returns:

XML string of history objects

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.getHistoryXML(java.lang.String)

getHistoryXML2

public String getHistoryXML2(String language)
                      throws SaWorkflowException

Reads the second variant of process history as XML.

Specified by:

getHistoryXML2 in interface SaWFTask

Parameters:

language - Language

Returns:

XML string of history objects

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.getHistoryXML2(java.lang.String)

getHistoryXML2

public String getHistoryXML2(String language,
                    boolean isAscending)
                      throws SaWorkflowException

Reads the second variant of process history as XML with ascending / descending switch.

Specified by:

getHistoryXML2 in interface SaWFTask

Parameters:

language - Language

isAscending - Is ascending

Returns:

XML string of history objects

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.getHistoryXML2(java.lang.String, boolean)

getSync

public boolean getSync()
                throws SaWorkflowException

Reads the sync status.

Specified by:

getSync in interface SaWFTask

Returns:

Is Synchron

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.getSync()

getTrusted

public boolean getTrusted()
                   throws SaWorkflowException

Reads the trusted status.

Specified by:

getTrusted in interface SaWFTask

Returns:

Is trusted

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.getTrusted()

getWorkingTime

public int getWorkingTime()
                   throws SaWorkflowException

Specified by:

getWorkingTime in interface SaWFTask

Returns:

the workingTime

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.getWorkingTime()

getTaskInfo

public TaskInfo getTaskInfo()
                     throws SaWorkflowException

Reads the task info object of this task.

Specified by:

getTaskInfo in interface SaWFTask

Returns:

TaskInfo object for this task

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.getTaskInfo()

readAttachmentMetadata

public SaPropertyValue[] readAttachmentMetadata()
                                         throws SaSystemException,
                                                SaAuthenticationException,
                                                SaDDCException,
                                                SaWorkflowException

Reads the metadata of the attachment.

Specified by:

readAttachmentMetadata in interface SaWFTask

Returns:

Metadata array of attachment

Throws:

SaSystemException - SaSystemException

SaAuthenticationException - SaAuthenticationException

SaDDCException - SaDDCException

SaWorkflowException - Workflow exception

See Also:

SaWFTask.readAttachmentMetadata()

setAliasActor

public void setAliasActor(ActorInfo aliasActor)
                   throws SaWorkflowException

Sets the alias actor.

Specified by:

setAliasActor in interface SaWFTask

Parameters:

aliasActor - Alias actor

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.setAliasActor(com.saperion.intf.wf.ActorInfo)

setAlias

public void setAlias(ActorInfo alias)
              throws SaWorkflowException

Sets the actor to be used as alias for the next action.

Specified by:

setAlias in interface SaWFTask

Parameters:

alias - alias actor

Throws:

SaWorkflowException - workflow exception

See Also:

SaWFTask.setAlias(com.saperion.intf.wf.ActorInfo)

addComment

public void addComment(String commentString,
              int level)
                throws SaAuthenticationException,
                       SaSystemException,
                       SaWorkflowException

Adds a comment to the workflow.

Specified by:

addComment in interface SaWFTask

Parameters:

commentString - Comment

level - Level

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

SaWorkflowException - Workflow exception

See Also:

SaWFTask.addComment(java.lang.String, int)

setComment

public void setComment(String commentString)

Set comment to the next execute.

Specified by:

setComment in interface SaWFTask

Parameters:

commentString - Comment string

See Also:

SaWFTask.setComment(java.lang.String)

addHistory

public void addHistory(String descriptionString)
                throws SaAuthenticationException,
                       SaSystemException,
                       SaWorkflowException

Adds a history entry.

Specified by:

addHistory in interface SaWFTask

Parameters:

descriptionString - Comment

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

SaWorkflowException - Workflow exception

See Also:

SaWFTask.addHistory(java.lang.String)

setSync

public void setSync(boolean isSync)
             throws SaWorkflowException

Set sync parameter. Default is "true".

Specified by:

setSync in interface SaWFTask

Parameters:

isSync - Synchron work

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.setSync(boolean)

setTrusted

public void setTrusted(boolean isTrusted)
                throws SaWorkflowException

Set trusted parameter. Default is "false".

Specified by:

setTrusted in interface SaWFTask

Parameters:

isTrusted - Trusted work

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.setTrusted(boolean)

setWorkingTime

public void setWorkingTime(int time)
                    throws SaWorkflowException

Specified by:

setWorkingTime in interface SaWFTask

Parameters:

time - the workingTime to set

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.setWorkingTime(int)

updateAttachment

public SaSaveInfo updateAttachment(Properties namevaluePairs,
                          InputStream[] content,
                          String versionComment,
                          String acls)
                            throws SaSystemException,
                                   SaAuthenticationException,
                                   SaDDCException,
                                   SaWorkflowException

Updates the attachment in the backend system with the given metadata, acls and content. Only the attached metadata and elements are changed. If the document was checked out, it will be automatically checked in.

Specified by:

updateAttachment in interface SaWFTask

Parameters:

namevaluePairs - A properties object containing the metadata

content - Multiple content data

versionComment - The comment for the version

acls - ACL name string

Returns:

SaSaveInfo SaSaveInfo object describing the document

Throws:

SaSystemException - SaSystemException

SaAuthenticationException - SaAuthenticationException

SaDDCException - SaDDCException

SaWorkflowException - Workflow exception

See Also:

SaWFTask.updateAttachment(java.util.Properties, java.io.InputStream[], java.lang.String, java.lang.String)

updateTask

public void updateTask(Properties values)
                throws SaWorkflowException

Updates the user defined fields of this task.

Specified by:

updateTask in interface SaWFTask

Parameters:

values - Fieldvalues

Throws:

SaWorkflowException - Workflow exception

See Also:

SaWFTask.updateTask(java.util.Properties)