Package com.axemble.vdoc.sdk.interfaces

Interface IAgentProcessingContext

public interface IAgentProcessingContext
Interface of the agent processing context This object carries the information related to the execution context of the IAgentProcessing The following methods are available to gets module object: - getPortalModule() : the module to manipulate the portal system; - getDirectoryModule() : the module to manipulate the directory system; - getProjectModule() : the module to manipulate the project system; - getWorkflowModule() : the module to manipulate the workflow system; The following methods are available to manipulate the agent: - getConfiguration() - getAgent() - getLastRunDate() - isAbortSignalReceived() IStoppableAgentProcessing The following methods are available to manipulate the report: - getReport() - printSeparator() - printLine()

  • Method Details

    • getPortalModule

      IBasePortalModule getPortalModule()
      Gets the portal module object.
      Returns:
      A IBasePortalModule object.

    • getDirectoryModule

      IBaseDirectoryModule getDirectoryModule()
      Gets the directory module object.
      Returns:
      A IBaseDirectoryModule object.

    • getProjectModule

      IProjectModule getProjectModule()
      Gets the project module object.
      Returns:
      A IProjectModule object.

    • getWorkflowModule

      IBaseWorkflowModule getWorkflowModule()
      Gets the workflow module object.
      Returns:
      A IBaseWorkflowModule object.

    • getConfiguration

      Element getConfiguration()
      Allows to retrieve the configuration of the current agent.
      Returns:
      The org.w3c.dom.Element of the current agent.

    • getAgent

      IAgent getAgent()
      Allows to retrieve the current agent.
      Returns:
      An IAgent object.

    • printSeparator

      void printSeparator()
      Print a separator into the agent administration report tab

    • printLine

      void printLine()
      Print an empty line into the agent administration report tab

    • getReport

      IReport getReport()
      Returns:
      this agent report collector

    • getLastRunDate

      Date getLastRunDate()
      Returns:
      last time this agent was executed

    • isAbortSignalReceived

      boolean isAbortSignalReceived()
      Indicates if the agent received an abort signal or not
      Returns:
      true if agent received an abort signal, otherwise false