Package com.saperion.connector.rmi

Class AbstractWfRMIClientCommand

java.lang.Object

com.saperion.connector.rmi.AbstractRMIClientCommand

com.saperion.connector.rmi.AbstractFolderRMIClientCommand

com.saperion.connector.rmi.AbstractDocRMIClientCommand

com.saperion.connector.rmi.AbstractQueryRMIClientCommand

com.saperion.connector.rmi.AbstractWfRMIClientCommand

All Implemented Interfaces:

SaRMIClientCommand

Direct Known Subclasses:

SaRMIClientCommandImpl

public abstract class AbstractWfRMIClientCommand
extends AbstractQueryRMIClientCommand

Class representing the workflow operations of the backend.

Field Summary

Fields inherited from class com.saperion.connector.rmi.AbstractRMIClientCommand

APPEND_CONTENT, appl, credentials, LOGGER, props, session, sessionInfo, sysConnector, writeBufferSize

Constructor Summary

Constructors

Constructor	Description
AbstractWfRMIClientCommand()

Method Summary

Modifier and Type	Method	Description
void	addComment(java.lang.String comment, java.lang.String taskUID, int level)
void	addHistory(java.lang.String description, java.lang.String taskUID)
java.lang.String	executeCommand(ContextInfo contextInfo)	Performs the given command.
BoxCount	getBoxCount(int boxId, BoxCountType type, java.util.Map<java.lang.String,java.lang.Object> parameters)	Returns the number of all elements and of all unread elements of the inbox identified by the given id.
java.util.List<BoxDefinition>	getBoxDefinitions()	Reads the box definitions.
java.util.Collection<CommandInfo>	getCommandInfos(java.lang.String taskUID)	Reads all possible transitions for this task.
java.util.Collection<CommandInfo>	getCommandInfos(java.lang.String taskUID, boolean transitionsOnly)	Reads all possible transitions and optional other possible commands for this task.
java.util.List<CommentInfo>	getCommentInfos(java.lang.String taskUID)	Reads the comments for the given task.
java.util.List<java.util.List<HistoryInfo>>	getCompleteHistoryInfos(java.lang.String docUID)	Reads the history for the given task.
java.util.List<HistoryInfo>	getHistoryInfos(java.lang.String taskUID)	Reads the history for the given task.
boolean	getOutOfOffice()	Get the out of office status for the logged on user.
TaskInfo	getParentTask(java.lang.String taskID)	Reads the parent task info for the given ID.
java.lang.String	getSubstitute()	Get the substitute for the logged on user.
TaskInfo	getTask(java.lang.String taskID)	Reads the task info for the given ID.
java.util.List<TaskAuditInfo>	getTaskAuditList(int[] ids, java.lang.String filter, java.util.Map<java.lang.String,java.lang.Object> parameter)	Reads the task audit for this user.
java.util.List<TaskInfo>	getTaskList(int[] ids, java.lang.String filter, java.util.Map<java.lang.String,java.lang.Object> parameter)	Reads the task for this user.
java.util.List<java.lang.String>	getUsers(java.lang.String filter)	Reads a list of filtered users.
java.util.List<java.lang.String>	getWorkflowDefinitions()	Reads all available workflow definitions.
void	setOutOfOffice(boolean isOutOfOffice)	Set the out of office status for the logged on user.
void	setSubstitute(java.lang.String substituteName)	Set the substitute for the logged on user.

Methods inherited from class com.saperion.connector.rmi.AbstractQueryRMIClientCommand

finishSQLTransaction, getFulltext, getHDocForSysRowId, getIdsFromQuery, getStringQueryResult, getVersionList, readDocumentMetadata, startSQLTransaction

Methods inherited from class com.saperion.connector.rmi.AbstractDocRMIClientCommand

cacheDocument, checkoutDocument, checkoutDocument, checkSapUrl, clearContent, closeDocument, createDocument, createExternalStorageFolderMapping, createLink, deleteDocument, deleteExternalStorageFolderMapping, discardDocument, dsicardCheckout, finishTransaction, getACLNames, getACLRights, getAcls, getAllACLs, getAnnotations, getExternalStorageFoldersForUpload, getExternalStorageFoldersForUpload, getExternalStorageMapping, getInvolvedUsers, getLockInfo, getLocks, getLocks, getNodeAccessData, getThumbnail, lockNode, logClientEvent, readDocumentFirst, readDocumentFirst, readDocumentNext, readVersionMetadata, readVersionMetadata, releaseDocument, removeElement, removeElement, restoreVersion, saveDocument, saveDocument, setACLName, setAnnotations, setElementMark, setVariables, startTransaction, storeDocument, storeDocument, unlockNode, updateExternalStorageUploadStatus, writeContent, writeContent, writeContent, writeContent

Methods inherited from class com.saperion.connector.rmi.AbstractFolderRMIClientCommand

addToFolder, copyFolder, createFolder, deleteFolder, getDocumentFolderCount, getDocumentFolders, getFolderChildren, getFolderClass, getFolderFromPath, getFolderInfo, getFolderParent, getFolderRights, getFolderUpdateInfo, moveFolder, moveToFolder, removeFromFolder, searchFolderClass, searchFolderDocuments, setFolderAcl, updateFolder

Methods inherited from class com.saperion.connector.rmi.AbstractRMIClientCommand

getRemoteCommand, init, reLogon, reLogonAfterConnectionFailure

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.saperion.connector.rmi.SaRMIClientCommand

changePassword, closeSession, deleteSetting, getArchivedSize, getAuthorizedUsers, getCommitMode, getCurrentUserRole, getDDC, getDeleteMode, getEventsEnabled, getFeatures, getFieldDescriptions, getFieldDescriptions, getFullTextFields, getLicenseCount, getMandant, getMember, getMembers, getRealDBName, getRMIVersion, getServerInfos, getSession, getSetting, getSystemConnector, getSystemFiles, getSystemInfo, getSystemSetting, getToken, getUserIdsForQuery, getUserSetting, invoke, isAlive, isRevisionEnabled, listActiveSessions, loadDDCNames, loadFolderDDCNames, loadSettings, loadSystemFile, loadWorkflowDDCName, logoff, logon, logon, logon, newInvoke, resolveLatestHdoc, searchSettings, sendBarcode, setEventsEnabled, setLocale, setSetting, setUsedLicense, setUserSetting, storeSystemFile

Constructor Detail

AbstractWfRMIClientCommand

public AbstractWfRMIClientCommand()

Method Detail

getTaskList

public java.util.List<TaskInfo> getTaskList(int[] ids,
                                            java.lang.String filter,
                                            java.util.Map<java.lang.String,java.lang.Object> parameter)
                                     throws SaAuthenticationException,
                                            SaSystemException

Reads the task for this user.

Parameters:

ids - Array of ID's

filter - HQL filter

parameter - Filter parameter

Returns:

List of TaskInfo objects

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

SaRMIClientCommand.getTaskList(int[], String, java.util.Map)

getTaskAuditList

public java.util.List<TaskAuditInfo> getTaskAuditList(int[] ids,
                                                      java.lang.String filter,
                                                      java.util.Map<java.lang.String,java.lang.Object> parameter)
                                               throws SaAuthenticationException,
                                                      SaSystemException

Reads the task audit for this user.

Parameters:

ids - Array of ID's

filter - HQL filter

parameter - Filter parameter

Returns:

List of TaskAuditInfo objects

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

SaRMIClientCommand.getTaskAuditList(int[], String, java.util.Map)

getTask

public TaskInfo getTask(java.lang.String taskID)
                 throws SaAuthenticationException,
                        SaSystemException

Reads the task info for the given ID.

Parameters:

taskID - Task SysRowId

Returns:

Task info

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

SaRMIClientCommand.getTask(String)

getParentTask

public TaskInfo getParentTask(java.lang.String taskID)
                       throws SaAuthenticationException,
                              SaSystemException

Reads the parent task info for the given ID.

Parameters:

taskID - Task SysRowId

Returns:

Task info

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

SaRMIClientCommand.getParentTask(String)

getCommandInfos

public java.util.Collection<CommandInfo> getCommandInfos(java.lang.String taskUID)
                                                  throws SaAuthenticationException,
                                                         SaSystemException

Reads all possible transitions for this task.

Parameters:

taskUID - Task UID

Returns:

Command list

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

SaRMIClientCommand.getCommandInfos(String)

getCommandInfos

public java.util.Collection<CommandInfo> getCommandInfos(java.lang.String taskUID,
                                                         boolean transitionsOnly)
                                                  throws SaAuthenticationException,
                                                         SaSystemException

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

Parameters:

taskUID - Task UID

transitionsOnly - if true, only transition commands will be returned

Returns:

Command list

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

SaRMIClientCommand.getCommandInfos(String, boolean)

getBoxDefinitions

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

Reads the box definitions.

Returns:

Box definitions

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

SaRMIClientCommand.getBoxDefinitions()

getBoxCount

public BoxCount getBoxCount(int boxId,
                            BoxCountType type,
                            java.util.Map<java.lang.String,java.lang.Object> parameters)
                     throws SaAuthenticationException,
                            SaSystemException

Returns the number of all elements and of all unread elements of the inbox identified by the given id.

Parameters:

boxId - the workflow box id

type - type of tasks to search for

parameters - parameters needed for searching

Returns:

number of all elements and of all unread elements

Throws:

SaAuthenticationException - if an error occurs.

SaSystemException - if an error occurs.

See Also:

SaRMIClientCommand.getBoxCount(int, com.saperion.wf.BoxCountType, java.util.Map)

executeCommand

public java.lang.String executeCommand(ContextInfo contextInfo)
                                throws SaAuthenticationException,
                                       SaSystemException,
                                       SaWorkflowException

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

Parameters:

contextInfo - Context info

Returns:

New TaskID

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

SaWorkflowException - Workflow exception

See Also:

SaRMIClientCommand.executeCommand(com.saperion.intf.wf.ContextInfo)

addComment

public void addComment(java.lang.String comment,
                       java.lang.String taskUID,
                       int level)
                throws SaAuthenticationException,
                       SaSystemException,
                       SaWorkflowException

Parameters:

comment - Comment

taskUID - Task UID

level - Level

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

SaWorkflowException - Workflow exception

See Also:

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

addHistory

public void addHistory(java.lang.String description,
                       java.lang.String taskUID)
                throws SaAuthenticationException,
                       SaSystemException,
                       SaWorkflowException

Parameters:

description - Comment

taskUID - Task UID

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

SaWorkflowException - Workflow exception

See Also:

SaRMIClientCommand.addHistory(java.lang.String, java.lang.String)

getCommentInfos

public java.util.List<CommentInfo> getCommentInfos(java.lang.String taskUID)
                                            throws SaAuthenticationException,
                                                   SaSystemException,
                                                   SaWorkflowException

Reads the comments for the given task.

Parameters:

taskUID - Task UID

Returns:

List of comments

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

SaWorkflowException - Workflow exception

See Also:

SaRMIClientCommand.getCommentInfos(java.lang.String)

getHistoryInfos

public java.util.List<HistoryInfo> getHistoryInfos(java.lang.String taskUID)
                                            throws SaAuthenticationException,
                                                   SaSystemException,
                                                   SaWorkflowException

Reads the history for the given task.

Parameters:

taskUID - Task UID

Returns:

History list

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

SaWorkflowException - Workflow exception

See Also:

SaRMIClientCommand.getHistoryInfos(java.lang.String)

getCompleteHistoryInfos

public java.util.List<java.util.List<HistoryInfo>> getCompleteHistoryInfos(java.lang.String docUID)
                                                                    throws SaAuthenticationException,
                                                                           SaSystemException,
                                                                           SaWorkflowException

Reads the history for the given task.

Parameters:

docUID - Document UID

Returns:

CompleteHistoryInfo

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

SaWorkflowException - Workflow exception

See Also:

SaRMIClientCommand.getCompleteHistoryInfos(java.lang.String)

getWorkflowDefinitions

public java.util.List<java.lang.String> getWorkflowDefinitions()
                                                        throws SaAuthenticationException,
                                                               SaSystemException,
                                                               SaWorkflowException

Reads all available workflow definitions.

Returns:

Workflowdefinition list

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

SaWorkflowException - Workflow exception

See Also:

SaRMIClientCommand.getWorkflowDefinitions()

getOutOfOffice

public boolean getOutOfOffice()
                       throws SaAuthenticationException,
                              SaSystemException

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

Returns:

is OutOfOffice

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

SaRMIClientCommand.getOutOfOffice()

getSubstitute

public java.lang.String getSubstitute()
                               throws SaAuthenticationException,
                                      SaSystemException

Get the substitute for the logged on user.

Returns:

Substitute name

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

SaRMIClientCommand.getSubstitute()

setOutOfOffice

public void setOutOfOffice(boolean isOutOfOffice)
                    throws SaAuthenticationException,
                           SaSystemException

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

Parameters:

isOutOfOffice - True, if is OutOfOffice

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

SaRMIClientCommand.setOutOfOffice(boolean)

setSubstitute

public void setSubstitute(java.lang.String substituteName)
                   throws SaAuthenticationException,
                          SaSystemException

Set the substitute for the logged on user.

Parameters:

substituteName - Substitute name

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

SaRMIClientCommand.setSubstitute(java.lang.String)

getUsers

public java.util.List<java.lang.String> getUsers(java.lang.String filter)
                                          throws SaAuthenticationException,
                                                 SaSystemException

Reads a list of filtered users.

Parameters:

filter - Filter

Returns:

List of users

Throws:

SaAuthenticationException - SaAuthenticationException

SaSystemException - SaSystemException

See Also:

SaRMIClientCommand.getUsers(java.lang.String)