Package com.aquima.interactions.portal

Interface ISessionMonitor

All Superinterfaces:
Serializable
All Known Implementing Classes:
ProcessEnabledSessionMonitor, SessionMonitor
public interface ISessionMonitor extends Serializable
This interface provides monitoring information about the portal session.
Since:
5.1
Author:
Jon van Leuven

  • Method Details

    • getSessionInfo

      IParameters getSessionInfo()
      Returns extra information about the session.
      Returns:
      may be null

    • getStartTime

      DateTimeValue getStartTime()
      Method for retrieving the sessions start time.
      Returns:
      the time the session was started

    • getTimeTracker

      ITimeTracker getTimeTracker()
      Retrieves the time tracker used in the active session.
      Returns:
      time tracker
      Throws:
      NoActiveSessionException - when the session is ended (not active)

    • getXmlProfileView

      String getXmlProfileView()
      Returns the profile view which as current state of the profile. Including which attributes are sourced by rules and which other attributes are dependent on this attribute's value.
      Returns:
      String the XML in UTF-8 format
      Throws:
      AppException - This exception is raised when the XML could not be generated.

    • getXmlMetaModelView

      String getXmlMetaModelView()
      This method returns the current definitions from the meta model as XML. The resulting XML string will be encoded in UTF-8.
      Returns:
      The meta model definitions as XML string.
      Throws:
      AppException - This exception is raised when the XML could not be generated.

    • getXmlStateView

      String getXmlStateView()
      Returns the flow transaction view which as current state of the flow state..
      Returns:
      String the XML in UTF-8 format
      Throws:
      AppException - This exception is raised when the XML could not be generated.

    • getCurrentState

      String getCurrentState()
      This method creates a dump of the current session state that may be used to restore the session at a later time.
      Returns:
      A dump of the current session state.
      Throws:
      AppException - This exception is thrown when the current session could not be saved to an object.

    • getCurrentSessionState

      ISessionState getCurrentSessionState()
      This method creates a dump of the current session state that may be used to restore the session at a later time.
      Returns:
      The state
      Throws:
      AppException - This exception is thrown when the current session could not be saved to an object.