Package com.aquima.interactions.portal.model

Interface ISessionState

All Superinterfaces:
Serializable
All Known Implementing Classes:
SessionState
public interface ISessionState extends Serializable
Interface for a session state object that can be used to restore a session.
Since:
6.3
Author:
O. Kerpershoek

  • Method Details

    • getApplicationId

      ApplicationID getApplicationId()
      This method returns the ID of the application for which the session was saved.
      Returns:
      the ID of the application for which the session was saved.

    • getLanguageCode

      String getLanguageCode()
      This method returns the current language (code) of the session.
      Returns:
      the current language (code) of the session.

    • getFlowState

      IFlowState getFlowState()
      This method returns the flow state of the session.
      Returns:
      the flow state of the session.

    • getPageScope

      PageScope getPageScope(ISolution solution)
      This method (re)creates the page scope using the definitions from the application model.
      Parameters:
      solution - The application model containing the definitions of the application.
      Returns:
      Page scope for the session.
      Throws:
      AppException - This exception is thrown when the page scope could not be created.

    • getSessionScope

      SessionScope getSessionScope(ISolution solution)
      This method (re)creates the session scope using the definitions from the application model.
      Parameters:
      solution - The application model containing the definitions of the application.
      Returns:
      Session scope for the session.
      Throws:
      AppException - This exception is thrown when the session scope could not be created.

    • initializeProfile

      void initializeProfile(IModule module, IProfile profile)
      This method is invoked to allow the session state to initialize the profile with the values of the saved session.
      Parameters:
      module - The application model containing the definitions of the application.
      profile - The profile that should be initialized.
      Throws:
      AppException - This exception is thrown when the profile could not be initialized.

    • getInstanceContext

      IInstanceContext getInstanceContext(TmsProfile tmsProfile)
      This method (re)creates the instance context for the session.
      Parameters:
      tmsProfile - The profile that should be used for the root context.
      Returns:
      The instance context for the session.
      Throws:
      AppException - This exception is thrown when the instance context could not be created.

    • getFlowScope

      FlowScope getFlowScope()
      This method (re)creates the flow scope.
      Returns:
      Flow scope for the session.
      Throws:
      AppException - This exception is thrown when the flow scope could not be created.

    • getCurrentPage

      IPage getCurrentPage()
      This method (re)creates the current page.
      Returns:
      The current page, may be null.
      Since:
      9.0