Package com.arbortext.e3

Interface E3Subprocess

public interface E3Subprocess
Describes an E3 Subprocess. Each instance of an object implementing this interface corresponds to a real, running, E3 subprocess on the E3 server machine.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    UNKNOWN_PROCESS_ID
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancelOperation()
    Cancel the current operation and free this subprocess.
    void
    deallocate()
    Frees this subprocess and returns it to the pool of usable services.
    String
    evaluateFunction(String commandLine)
    Passes an ACL function to the E3 subprocess for evaluation.
    String
    evaluateFunction(String commandLine, com.arbortext.e3.E3Transaction transaction)
    Passes an ACL function to the E3 subprocess for evaluation.
    void
    executeCommand(String commandLine)
    Passes an ACL command to the E3 subprocess for execution.
    void
    executeCommand(String commandLine, com.arbortext.e3.E3Transaction transaction)
    Passes an ACL command to the E3 subprocess for execution.
    int
    getPid()
    Returns the process ID of the PE subprocess corresponding to this subprocess object.
    E3SubprocessPool
    getSubprocessPool()
    Returns the subprocess pool containing this subprocess.

  • Field Details

  • Method Details

    • cancelOperation

      void cancelOperation()
      Cancel the current operation and free this subprocess.

    • deallocate

      void deallocate()
      Frees this subprocess and returns it to the pool of usable services. If the subprocess is associated with the thread, it would be deallocate through the method.

    • evaluateFunction

      String evaluateFunction(String commandLine) throws com.arbortext.e3.E3RequestException
      Passes an ACL function to the E3 subprocess for evaluation.
      Parameters:
      commandLine - function to evaluate
      Returns:
      result string returned by Epic
      Throws:
      com.arbortext.e3.E3RequestException - thrown if evaluation fails

    • evaluateFunction

      String evaluateFunction(String commandLine, com.arbortext.e3.E3Transaction transaction) throws com.arbortext.e3.E3RequestException
      Passes an ACL function to the E3 subprocess for evaluation.
      Parameters:
      commandLine - function to evaluate
      transaction - transaction being processed (so transaction-related data can be included in error messages); may be null.
      Returns:
      result string returned by Epic
      Throws:
      com.arbortext.e3.E3RequestException - thrown if evaluation fails

    • executeCommand

      void executeCommand(String commandLine) throws com.arbortext.e3.E3RequestException
      Passes an ACL command to the E3 subprocess for execution.
      Parameters:
      commandLine - command to execute
      Throws:
      com.arbortext.e3.E3RequestException - thrown if execution fails.

    • executeCommand

      void executeCommand(String commandLine, com.arbortext.e3.E3Transaction transaction) throws com.arbortext.e3.E3RequestException
      Passes an ACL command to the E3 subprocess for execution.
      Parameters:
      commandLine - command to execute
      transaction - transaction being processed (so transaction-related data can be included in error messages); may be null.
      Throws:
      com.arbortext.e3.E3RequestException - thrown if execution fails.

    • getPid

      int getPid()
      Returns the process ID of the PE subprocess corresponding to this subprocess object.
      Returns:
      integer Process ID.

    • getSubprocessPool

      E3SubprocessPool getSubprocessPool()
      Returns the subprocess pool containing this subprocess.
      Returns:
      E3SubprocessPool object