com.ibm.itim.apps.workflow

Class WorkflowManager

  • java.lang.Object
    • com.ibm.itim.apps.workflow.WorkflowManager

  • public class WorkflowManager
extends java.lang.Object
    Provides the ability to query workflow processes within the workflow engine.

    • Constructor Summary

      Constructors 
      Constructor and Description
      WorkflowManager(PlatformContext platform, javax.security.auth.Subject subject)
      Constructs the manager with a platform context and a subject.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.Collection getActiveProcesses()
      Returns all of the active processes in the workflow engine.
      java.util.Collection getActiveProcesses(java.lang.String defid)
      Returns all of the active processes of the given workflow process definition id in the workflow engine.
      WorkflowProcessMO getProcess(long id)
      Returns the process for the given Id.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • WorkflowManager

        public WorkflowManager(PlatformContext platform,
                       javax.security.auth.Subject subject)
        Constructs the manager with a platform context and a subject.
        Parameters:
        platform - PlatformContext holding platform connection information.
        subject - Subject representing the authenticated caller.

    • Method Detail

      • getProcess

        public WorkflowProcessMO getProcess(long id)
                             throws ApplicationException
        Returns the process for the given Id. If the user is unauthorized to view the process with the given Id, an AuthorizationException will not be thrown, and instead, null will be returned.
        Parameters:
        id - Id of the process
        Returns:
        WorkflowProcessMO representing the process with the given Id, null if none found.
        Throws:
        java.rmi.RemoteException - Thrown if unable to communicate with platform.
        ApplicationException - Thrown if unable retrieve the process.

      • getActiveProcesses

        public java.util.Collection getActiveProcesses()
                                        throws java.rmi.RemoteException,
                                               ApplicationException
        Returns all of the active processes in the workflow engine. If the user is not authorized to view one of the active processes, it will be filtered out of the returned set.
        Returns:
        Collection of WorkflowProcessMO representing active processes.
        Throws:
        java.rmi.RemoteException - Thrown if unable to communicate with platform.
        ApplicationException - Thrown if unable to return the active processes.

      • getActiveProcesses

        public java.util.Collection getActiveProcesses(java.lang.String defid)
                                        throws java.rmi.RemoteException,
                                               ApplicationException
        Returns all of the active processes of the given workflow process definition id in the workflow engine. If the user is not authorized to view one of the active processes, it will be filtered out of the returned set.
        Parameters:
        defId - the identifier of the target workflow process definition.
        Returns:
        Collection of WorkflowProcessMO representing active processes of the given type.
        Throws:
        java.rmi.RemoteException - Thrown if unable to communicate with platform.
        ApplicationException - Thrown if unable to return the active processes.
Skip navigation links