Interface WorkflowStepsServiceLocal


  • public interface WorkflowStepsServiceLocal
    Local interface for the WorkflowSteps service from the Planner API
    • Method Detail

      • getWorkflowStep

        WorkflowStep getWorkflowStep​(java.lang.String id)
                              throws PubServerException,
                                     java.lang.NumberFormatException
        Returns the workflow step at the specified ID
        Parameters:
        id - workflow step ID
        Returns:
        the workflow step
        Throws:
        PubServerException
        java.lang.NumberFormatException
        See Also:
        WorkflowStep
      • getWorkflowSteps

        java.util.List<WorkflowStep> getWorkflowSteps​(java.lang.String processID)
                                               throws PubServerException,
                                                      java.lang.NumberFormatException
        Returns workflow steps for the specified process
        Parameters:
        processID - process ID
        Returns:
        the list of workflow steps
        Throws:
        PubServerException
        java.lang.NumberFormatException
        See Also:
        WorkflowStep
      • deleteWorkflowStep

        boolean deleteWorkflowStep​(java.lang.String id)
                            throws PubServerException,
                                   java.lang.NumberFormatException
        Deletes the workflow steps at the specified ID
        Parameters:
        id - workflow step ID
        Returns:
        true if success
        Throws:
        PubServerException
        java.lang.NumberFormatException
      • getNextWorkflowSteps

        java.util.List<WorkflowStep> getNextWorkflowSteps​(java.lang.String workflowStepID)
                                                   throws PubServerException,
                                                          java.lang.NumberFormatException
        Returns the next possible workflow steps after the specified one
        Parameters:
        workflowStepID - workflow step ID
        Returns:
        the list of workflow steps
        Throws:
        PubServerException
        java.lang.NumberFormatException
        See Also:
        WorkflowStep
      • setNextWorkflowSteps

        java.util.List<WorkflowStep> setNextWorkflowSteps​(java.lang.String parentworkflowStepID,
                                                          java.util.List<WorkflowStep> children)
                                                   throws PubServerException,
                                                          java.lang.NumberFormatException
        Sets the next possible workflow steps for the specified one
        Parameters:
        parentworkflowStepID - parent workflow step ID
        children - the list of next workflow steps
        Returns:
        the list of processed workflow steps
        Throws:
        PubServerException
        java.lang.NumberFormatException
        See Also:
        WorkflowStep
      • setWorkflowStepsForWorkflow

        java.util.List<WorkflowStep> setWorkflowStepsForWorkflow​(java.lang.String processID,
                                                                 java.util.List<WorkflowStep> workflowSteps)
                                                          throws PubServerException
        Sets workflow steps for the specified workflow
        Parameters:
        processID - process ID - to identity the workflow
        workflowSteps - the list of workflow steps to set
        Returns:
        the list of processed workflow steps with statuses of operation
        Throws:
        PubServerException
      • addWorkflowStepsForWorkflow

        java.util.List<WorkflowStep> addWorkflowStepsForWorkflow​(java.lang.String processID,
                                                                 java.util.List<WorkflowStep> workflowSteps)
                                                          throws PubServerException
        Adds workflow steps to the specified workflow
        Parameters:
        processID - process ID - to identity the workflow
        workflowSteps - the list of workflow steps to add
        Returns:
        the list of processed workflow steps with statuses of operation
        Throws:
        PubServerException