Package com.saperion.connector.wf

Class SaWFConnectorImpl

java.lang.Object

com.saperion.connector.wf.SaWFConnectorImpl

All Implemented Interfaces:

SaWFConnector

public class SaWFConnectorImpl
extends Object
implements SaWFConnector

Workflow connector implementation.

Author:

rbo

Constructor Summary

Constructors

Constructor	Description
SaWFConnectorImpl()	Constructs the SaWFConnectorImpl instance which provides workflow functionalities.
SaWFConnectorImpl(SaClassicConnector conn)	Constructor with given connector.
SaWFConnectorImpl(String configPath)	Constructs the SaWFConnectorImpl instance which provides workflow functionalities.

Method Summary

Modifier and Type	Method	Description
TaskInfo	executeStartProcess(String definition, ActorInfo nextActor, String comment, String attachmentUID)	Start new process.
Long	getBoxCount(int boxId)	Reads the count (number of workflow item) of the inbox identified by the given id.
List<BoxDefinition>	getBoxDefinitions()	Reads the box definitions.
SaClassicConnector	getClassicConnector()	Gets the classic connector behind this connector.
List<HistoryInfo[]>	getDocHistories(String documentHdoc)	Gets the document's process histories.
List<String>	getDocHistoriesXML(String documentHdoc)	Gets the document's process histories as XML.
List<String>	getDocHistoriesXML(String documentHdoc, String language)	Gets the document's process histories as XML.
List<String>	getDocHistoriesXML2(String documentHdoc, String language)	Gets the the second variant of document's process histories as XML.
List<String>	getDocHistoriesXML2(String documentHdoc, String language, boolean isAscending)	Gets the the second variant of document's process histories as XML with ascending/descending switch.
List<TaskInfo>	getGroupbox(int[] ids, String filter)	Read the content of the group box.
List<TaskInfo>	getInbox(String filter)	Read the content of the inbox.
WorkflowMember	getMember(WorkflowMember member, int depth, String filter)	Reads direct workflow member tree.
WorkflowMember	getMembers()	Reads the workflow member tree.
List<TaskInfo>	getOrgUnitbox(int[] ids, String filter)	Read the content of the organisation unit box.
boolean	getOutOfOffice()	Get the out of office status for the logged on user.
SaWFTask	getParentTask(String taskId)	Get parent task direct by ID.
List<String>	getProcessDefinitions()	Reads all available process definitions.
List<ProcessDefinitionDescriptor>	getProcessDefinitions(String ddcName)	Returns the process definitions that are allowed to be used for documents contained in the specified DDC.
String	getSubstitute()	Get the substitute for the logged on user.
List<TaskInfo>	getSubstitutebox(int[] ids, String filter)	Read the content of the substitute box.
SaWFTask	getTask(TaskInfo taskInfo)	Creates a task object from the given task information.
SaWFTask	getTask(String taskId)	Get task direct by ID.
List<TaskAuditInfo>	getTaskAuditList(int[] boxIds, String filter)	Reads the task audit for this user.
List<TaskAuditInfo>	getTaskAuditList(int[] boxIds, String filter, Map<String,Object> parameter)	Reads the task audit for this user.
List<TaskInfo>	getTaskList(int[] boxIds, String filter)	Reads the task for this user.
List<TaskInfo>	getTaskList(int[] boxIds, String filter, Map<String,Object> parameter)	Reads the task for this user.
int	getUserId()	User ID for the actual user.
String	getWorkflowDdcName()	Gets the workflow ddc name
String	getXMLTaskList(List<TaskInfo> taskList)	Converts a task list to xml.
boolean	logoff()	Logoff from the backend system.
int	logon(String username, String password, int type, String client)	performs logon to the backend system.
void	setOutOfOffice(boolean isOutOfOffice)	set the out of office status for the logged on user.
void	setSubstitute(String name)	Set the substitute for the logged on user.

Methods inherited from class java.lang.Object

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

Constructor Details

SaWFConnectorImpl

public SaWFConnectorImpl()
                  throws SaAuthenticationException,
SaSystemException

Constructs the SaWFConnectorImpl instance which provides workflow functionalities.

Throws:

SaSystemException - System exception

SaAuthenticationException - Authentication exception

SaWFConnectorImpl

public SaWFConnectorImpl(String configPath)
                  throws SaAuthenticationException,
SaSystemException

Constructs the SaWFConnectorImpl instance which provides workflow functionalities.

Parameters:

configPath - Configuration path

Throws:

SaSystemException - System exception

SaAuthenticationException - Authentication exception

SaWFConnectorImpl

public SaWFConnectorImpl(SaClassicConnector conn)
                  throws SaAuthenticationException,
SaSystemException

Constructor with given connector.

Parameters:

conn - Classic connector

Throws:

SaSystemException - System exception

SaAuthenticationException - Authentication exception

Method Details

getBoxDefinitions

public List<BoxDefinition> getBoxDefinitions()
                                      throws SaAuthenticationException,
SaSystemException

Reads the box definitions.

Specified by:

getBoxDefinitions in interface SaWFConnector

Returns:

Box definitions

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.getBoxDefinitions()

getBoxCount

public Long getBoxCount(int boxId)
                 throws SaAuthenticationException,
SaSystemException

Reads the count (number of workflow item) of the inbox identified by the given id. For more options (unread-count...) use invoke method of ClassicConnector with GetBoxCount operation.

Specified by:

getBoxCount in interface SaWFConnector

Parameters:

boxId - the workflow box id

Returns:

the count of the inbox as Long.

Throws:

SaAuthenticationException - if an error occurs.

SaSystemException - if an error occurs.

See Also:

• SaWFConnector.getBoxDefinitions()

getGroupbox

public List<TaskInfo> getGroupbox(int[] ids,
 String filter)
                           throws SaAuthenticationException,
SaSystemException

Read the content of the group box.

Specified by:

getGroupbox in interface SaWFConnector

Parameters:

ids - Filter ID's

filter - HQL filter

Returns:

List of TaskInfo objects

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.getGroupbox(int[], java.lang.String)

getInbox

public List<TaskInfo> getInbox(String filter)
                        throws SaAuthenticationException,
SaSystemException

Read the content of the inbox.

Specified by:

getInbox in interface SaWFConnector

Parameters:

filter - HQL filter

Returns:

List of TaskInfo objects

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.getInbox(java.lang.String)

getOrgUnitbox

public List<TaskInfo> getOrgUnitbox(int[] ids,
 String filter)
                             throws SaAuthenticationException,
SaSystemException

Read the content of the organisation unit box.

Specified by:

getOrgUnitbox in interface SaWFConnector

Parameters:

ids - Filter ID's

filter - HQL filter

Returns:

List of TaskInfo objects

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.getOrgUnitbox(int[], java.lang.String)

getTask

public SaWFTask getTask(TaskInfo taskInfo)
                 throws SaAuthenticationException,
SaSystemException,
SaWorkflowException

Creates a task object from the given task information.

Specified by:

getTask in interface SaWFConnector

Parameters:

taskInfo - Task information

Returns:

Task object

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

SaWorkflowException - Workflow exception

See Also:

• SaWFConnector.getTask(com.saperion.intf.wf.TaskInfo)

getTask

public SaWFTask getTask(String taskId)
                 throws SaAuthenticationException,
SaSystemException,
SaWorkflowException

Get task direct by ID.

Specified by:

getTask in interface SaWFConnector

Parameters:

taskId - Task SysRowId

Returns:

Task information

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

SaWorkflowException - Workflow exception

See Also:

• SaWFConnector.getTask(java.lang.String)

getParentTask

public SaWFTask getParentTask(String taskId)
                       throws SaAuthenticationException,
SaSystemException,
SaWorkflowException

Get parent task direct by ID.

Specified by:

getParentTask in interface SaWFConnector

Parameters:

taskId - Task SysRowId

Returns:

Task information

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

SaWorkflowException - Workflow exception

See Also:

• SaWFConnector.getParentTask(java.lang.String)

getSubstitutebox

public List<TaskInfo> getSubstitutebox(int[] ids,
 String filter)
                                throws SaAuthenticationException,
SaSystemException

Read the content of the substitute box.

Specified by:

getSubstitutebox in interface SaWFConnector

Parameters:

ids - Filter ID's

filter - HQL filter

Returns:

List of TaskInfo objects

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.getSubstitutebox(int[], java.lang.String)

getTaskList

public List<TaskInfo> getTaskList(int[] boxIds,
 String filter)
                           throws SaAuthenticationException,
SaSystemException

Reads the task for this user.

Specified by:

getTaskList in interface SaWFConnector

Parameters:

boxIds - BoxIds

filter - HQL filter. Optional WHERE condition that will be added to the original query.
In order to add the pagination functionality like setMaxResults() and/or setFirstResult(), add the following statements to the filter:
filter_stmt;MAXRESULTS=x ;FIRSTRESULT=y.
;MAXRESULTS=x - x means the limitation of the result set output.
;FIRSTRESULT=y - y means setting the result set cursor to the y-position.
Adding pagination is optional feature that can be used without filter statement as well. In other words filter might consist of ;MAXRESULTS=x ;FIRSTRESULT=y string only.

Examples:
1. LASTUSER ='Bolt';MAXRESULTS=50 ;FIRSTRESULT=1 - hql query's where condition is enhanced with restriction LASTUSER ='Bolt' and the pagination functionality setMaxResults() and setFirstResult() is used;

2. ;MAXRESULTS=50 - only setMaxResult() will be used.

using ; ist important for applying pagination.

Returns:

List of TaskInfo objects

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.getTaskList(int[], java.lang.String)

getTaskList

public List<TaskInfo> getTaskList(int[] boxIds,
 String filter,
 Map<String,Object> parameter)
                           throws SaAuthenticationException,
SaSystemException

Reads the task for this user.

Specified by:

getTaskList in interface SaWFConnector

Parameters:

boxIds - BoxIds

filter - HQL filter. Optional WHERE condition that will be added to the original query.
In order to add the pagination functionality like setMaxResults() and/or setFirstResult(), add the following statements to the filter:
filter_stmt;MAXRESULTS=x ;FIRSTRESULT=y.
;MAXRESULTS=x - x means the limitation of the result set output.
;FIRSTRESULT=y - y means setting the result set cursor to the y-position.
Adding pagination is optional feature that can be used without filter statement as well. In other words filter might consist of ;MAXRESULTS=x ;FIRSTRESULT=y string only.

Examples:
1. LASTUSER ='Bolt';MAXRESULTS=50 ;FIRSTRESULT=1 - hql query's where condition is enhanced with restriction LASTUSER ='Bolt' and the pagination functionality setMaxResults() and setFirstResult() is used;

2. ;MAXRESULTS=50 - only setMaxResult() will be used.

using ; ist important for applying pagination.

parameter - parameters for the filter-statement, if used

Returns:

List of TaskInfo objects

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.getTaskList(int[], java.lang.String, java.util.Map)

getTaskAuditList

public List<TaskAuditInfo> getTaskAuditList(int[] boxIds,
 String filter)
                                     throws SaAuthenticationException,
SaSystemException

Reads the task audit for this user.

Specified by:

getTaskAuditList in interface SaWFConnector

Parameters:

boxIds - BoxIds

filter - HQL filter

Returns:

List of TaskAuditInfo objects

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.getTaskAuditList(int[], java.lang.String)

getTaskAuditList

public List<TaskAuditInfo> getTaskAuditList(int[] boxIds,
 String filter,
 Map<String,Object> parameter)
                                     throws SaAuthenticationException,
SaSystemException

Reads the task audit for this user.

Specified by:

getTaskAuditList in interface SaWFConnector

Parameters:

boxIds - BoxIds

filter - HQL filter

parameter - Filter parameter

Returns:

List of TaskAuditInfo objects

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.getTaskAuditList(int[], java.lang.String, java.util.Map)

executeStartProcess

public TaskInfo executeStartProcess(String definition,
 ActorInfo nextActor,
 String comment,
 String attachmentUID)
                             throws SaWorkflowException

Start new process.

Specified by:

executeStartProcess in interface SaWFConnector

Parameters:

definition - Process definition

nextActor - Next actor

comment - Comment

attachmentUID - Attachment UID (a HDOC)

Returns:

Task info of new process

Throws:

SaWorkflowException - Workflow exception

See Also:

• SaWFConnector.executeStartProcess(java.lang.String, com.saperion.intf.wf.ActorInfo, java.lang.String, java.lang.String)

logoff

public boolean logoff()
               throws SaAuthenticationException,
SaSystemException

Logoff from the backend system. This command also destroys the command thread on the java broker server.

Specified by:

logoff in interface SaWFConnector

Returns:

boolean. True, if logoff successful.

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.logoff()

logon

public int logon(String username,
 String password,
 int type,
 String client)
          throws SaAuthenticationException,
SaSystemException

performs logon to the backend system.

Specified by:

logon in interface SaWFConnector

Parameters:

username - User's full name

password - Password

type - User type that means client license type. There are possible the following integer values:

1 = index

2 = query

3 = univeral administrator

4 = web query

7 = web index

12 = workflow

13 = scan

14 = highend scan

15 = API query

16 = API index

17 = API scan

20 = basic administrator

29 = web workflow

client - client/mandant name, used in multi-client systems

Returns:

User token for the current session.

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.logon(java.lang.String, java.lang.String, int, java.lang.String)

getUserId

public int getUserId()

User ID for the actual user.

Specified by:

getUserId in interface SaWFConnector

Returns:

User id

See Also:

• SaWFConnector.getUserId()

getXMLTaskList

public String getXMLTaskList(List<TaskInfo> taskList)

Converts a task list to xml.

Specified by:

getXMLTaskList in interface SaWFConnector

Parameters:

taskList - Task list

Returns:

Task XML as String

See Also:

• SaWFConnector.getXMLTaskList(java.util.List)

getProcessDefinitions

public List<String> getProcessDefinitions()
                                   throws SaAuthenticationException,
SaSystemException,
SaWorkflowException

Reads all available process definitions.

Specified by:

getProcessDefinitions in interface SaWFConnector

Returns:

Process definitions

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

SaWorkflowException - Workflow exception

See Also:

• SaWFConnector.getProcessDefinitions()

getProcessDefinitions

public List<ProcessDefinitionDescriptor> getProcessDefinitions(String ddcName)
                                                        throws SaAuthenticationException,
SaSystemException,
SaWorkflowException

Returns the process definitions that are allowed to be used for documents contained in the specified DDC. If no restrictions are configured, all process definitions will be returned.

Specified by:

getProcessDefinitions in interface SaWFConnector

Parameters:

ddcName - name of the DDC

Returns:

Workflowdefinition list

Throws:

SaAuthenticationException - authentication error when loading definitions

SaSystemException - system error when loading definitions

SaWorkflowException - workflow error when loading definitions

See Also:

• SaWFConnector.getProcessDefinitions(java.lang.String)

getOutOfOffice

public boolean getOutOfOffice()
                       throws SaAuthenticationException,
SaSystemException

Get the out of office status for the logged on user.

Specified by:

getOutOfOffice in interface SaWFConnector

Returns:

is OutOfOffice

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.getOutOfOffice()

getSubstitute

public String getSubstitute()
                     throws SaAuthenticationException,
SaSystemException

Get the substitute for the logged on user.

Specified by:

getSubstitute in interface SaWFConnector

Returns:

Substitute name

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.getSubstitute()

setOutOfOffice

public void setOutOfOffice(boolean isOutOfOffice)
                    throws SaAuthenticationException,
SaSystemException

set the out of office status for the logged on user.

Specified by:

setOutOfOffice in interface SaWFConnector

Parameters:

isOutOfOffice - True, if is OutOfOffice

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.setOutOfOffice(boolean)

setSubstitute

public void setSubstitute(String name)
                   throws SaAuthenticationException,
SaSystemException

Set the substitute for the logged on user.

Specified by:

setSubstitute in interface SaWFConnector

Parameters:

name - the fullname of the substitute user

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.setSubstitute(java.lang.String)

getDocHistories

public List<HistoryInfo[]> getDocHistories(String documentHdoc)
                                    throws SaWorkflowException

Gets the document's process histories.

Specified by:

getDocHistories in interface SaWFConnector

Parameters:

documentHdoc - Document's HDoc

Returns:

List of arrays of history objects

Throws:

SaWorkflowException - Workflow exception

See Also:

• SaWFConnector.getDocHistories(String)

getDocHistoriesXML

public List<String> getDocHistoriesXML(String documentHdoc)
                                throws SaWorkflowException

Gets the document's process histories as XML.

Specified by:

getDocHistoriesXML in interface SaWFConnector

Parameters:

documentHdoc - Document's UID

Returns:

List of XML strings of history objects

Throws:

SaWorkflowException - Workflow exception

See Also:

• SaWFConnector.getDocHistoriesXML(String)

getDocHistoriesXML

public List<String> getDocHistoriesXML(String documentHdoc,
 String language)
                                throws SaWorkflowException

Gets the document's process histories as XML.

Specified by:

getDocHistoriesXML in interface SaWFConnector

Parameters:

documentHdoc - Document's UID

language - Language

Returns:

List of XML strings of history objects

Throws:

SaWorkflowException - Workflow exception

See Also:

• SaWFConnector.getDocHistoriesXML(java.lang.String)

getDocHistoriesXML2

public List<String> getDocHistoriesXML2(String documentHdoc,
 String language)
                                 throws SaWorkflowException

Gets the the second variant of document's process histories as XML.

Specified by:

getDocHistoriesXML2 in interface SaWFConnector

Parameters:

documentHdoc - Document's UID

language - Language

Returns:

List of XML strings of history objects

Throws:

SaWorkflowException - Workflow exception

See Also:

• SaWFConnector.getDocHistoriesXML2(String, String)

getDocHistoriesXML2

public List<String> getDocHistoriesXML2(String documentHdoc,
 String language,
 boolean isAscending)
                                 throws SaWorkflowException

Gets the the second variant of document's process histories as XML with ascending/descending switch.

Specified by:

getDocHistoriesXML2 in interface SaWFConnector

Parameters:

documentHdoc - Document's UID

language - Language

isAscending - Is ascending

Returns:

List of XML strings of history objects

Throws:

SaWorkflowException - Workflow exception

See Also:

• SaWFConnector.getDocHistoriesXML2(String, String, boolean)

getMembers

public WorkflowMember getMembers()
                          throws SaAuthenticationException,
SaSystemException

Reads the workflow member tree.

Specified by:

getMembers in interface SaWFConnector

Returns:

Member tree

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.getMembers()

getMember

public WorkflowMember getMember(WorkflowMember member,
 int depth,
 String filter)
                         throws SaAuthenticationException,
SaSystemException

Reads direct workflow member tree.

Specified by:

getMember in interface SaWFConnector

Parameters:

member - workflow member, which children have to be returned.

depth - of children.

filter - filter string

Returns:

Member tree

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

• SaWFConnector.getMember(WorkflowMember, int, String)

getClassicConnector

public SaClassicConnector getClassicConnector()

Gets the classic connector behind this connector. ;

Specified by:

getClassicConnector in interface SaWFConnector

Returns:

Classic connector behind this connector

See Also:

• SaWFConnector.getClassicConnector()

getWorkflowDdcName

public String getWorkflowDdcName()
                          throws SaSystemException

Gets the workflow ddc name

Specified by:

getWorkflowDdcName in interface SaWFConnector

Returns:

the name of the workflow ddc

Throws:

SaSystemException

See Also:

• SaWFConnector.getWorkflowDdcName()