Package com.saperion.connector.wf

Interface SaWFConnector

  • All Known Implementing Classes:
    SaWFConnectorImpl
    public interface SaWFConnector
    Workflow Connector Interface.

    • Method Summary

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

    • Method Detail

      • logon

        int logon​(java.lang.String username,
          java.lang.String password,
          int type,
          java.lang.String client)
   throws SaAuthenticationException,
          SaSystemException
        performs logon to the backend system.
        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

      • getUserId

        int getUserId()
        User ID for the actual user.
        Returns:
        User id

      • getTaskList

        java.util.List<TaskInfo> getTaskList​(int[] boxIds,
                                     java.lang.String filter)
                              throws SaAuthenticationException,
                                     SaSystemException
        Reads the task for this user.
        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

      • getTaskList

        java.util.List<TaskInfo> getTaskList​(int[] boxIds,
                                     java.lang.String filter,
                                     java.util.Map<java.lang.String,​java.lang.Object> parameter)
                              throws SaAuthenticationException,
                                     SaSystemException
        Reads the task for this user.
        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

      • executeStartProcess

        TaskInfo executeStartProcess​(java.lang.String definition,
                             ActorInfo nextActor,
                             java.lang.String comment,
                             java.lang.String attachmentUID)
                      throws SaWorkflowException
        Start new process.
        Parameters:
        definition - Process definition
        nextActor - Next actor
        comment - Comment
        attachmentUID - Attachment UID (a HDOC)
        Returns:
        Task info of new process
        Throws:
        SaWorkflowException - Workflow exception

      • getXMLTaskList

        java.lang.String getXMLTaskList​(java.util.List<TaskInfo> taskList)
        Converts a task list to xml.
        Parameters:
        taskList - Task list
        Returns:
        Task XML as String

      • getDocHistories

        java.util.List<HistoryInfo[]> getDocHistories​(java.lang.String documentHdoc)
                                       throws SaWorkflowException
        Gets the document's process histories.
        Parameters:
        documentHdoc - Document's HDoc
        Returns:
        List of arrays of history objects
        Throws:
        SaWorkflowException - Workflow exception

      • getDocHistoriesXML

        java.util.List<java.lang.String> getDocHistoriesXML​(java.lang.String documentHdoc)
                                             throws SaWorkflowException
        Gets the document's process histories as XML.
        Parameters:
        documentHdoc - Document's UID
        Returns:
        List of XML strings of history objects
        Throws:
        SaWorkflowException - Workflow exception

      • getDocHistoriesXML

        java.util.List<java.lang.String> getDocHistoriesXML​(java.lang.String documentHdoc,
                                                    java.lang.String language)
                                             throws SaWorkflowException
        Gets the document's process histories as XML.
        Parameters:
        documentHdoc - Document's UID
        language - Language
        Returns:
        List of XML strings of history objects
        Throws:
        SaWorkflowException - Workflow exception

      • getDocHistoriesXML2

        java.util.List<java.lang.String> getDocHistoriesXML2​(java.lang.String documentHdoc,
                                                     java.lang.String language)
                                              throws SaWorkflowException
        Gets the the second variant of document's process histories as XML.
        Parameters:
        documentHdoc - Document's UID
        language - Language
        Returns:
        List of XML strings of history objects
        Throws:
        SaWorkflowException - Workflow exception

      • getDocHistoriesXML2

        java.util.List<java.lang.String> getDocHistoriesXML2​(java.lang.String documentHdoc,
                                                     java.lang.String language,
                                                     boolean isAscending)
                                              throws SaWorkflowException
        Gets the the second variant of document's process histories as XML with ascending/descending switch.
        Parameters:
        documentHdoc - Document's UID
        language - Language
        isAscending - Is ascending
        Returns:
        List of XML strings of history objects
        Throws:
        SaWorkflowException - Workflow exception

      • getClassicConnector

        SaClassicConnector getClassicConnector()
        Gets the classic connector behind this connector. ;
        Returns:
        Classic connector behind this connector

      • getWorkflowDdcName

        java.lang.String getWorkflowDdcName()
                             throws SaSystemException
        Gets the workflow ddc name
        Returns:
        the name of the workflow ddc
        Throws:
        SaSystemException