Interface IAquimaUi

public interface IAquimaUi
Interface for Aquima user interfaces.

An Aquima UI is a technique for rendering aquima elements and interacting with them (e.g. navigating, submitting forms).

Since:
8.0
Author:
Danny Roest, Jon van Leuven

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getLink(String sessionId)
    This method return the url link of aquima ui for the given session id.
    String
    getName()
    This method should return the unique name for this Aquima user interface.
    String
    getPath(String sessionId)
    This method return the url path of aquima ui for the given session id.
    String
    getSourceContentType()
    This method returns the content type of the element source.
    List<String>
    getThemes()
    This method returns the names of themes (css styles) for this AquimaUI.
    boolean
    hasCache()
    This method indicated if the web renderer has a cache (that can be reset).
    boolean
    resetCache()
    This method may be called to reset the cache of this web render engine.
    void
    writeSource(com.aquima.interactions.composer.ICompositeElement element, IRenderContext context, Writer result)
    This method may be used to write an elements source to a writer.

  • Method Details

    • getName

      String getName()
      This method should return the unique name for this Aquima user interface.
      Returns:
      The name, never null.

    • getPath

      String getPath(String sessionId)
      This method return the url path of aquima ui for the given session id.
      Parameters:
      sessionId - The current session id.
      Returns:
      the url path relative to the servlet path.

    • getLink

      String getLink(String sessionId)
      This method return the url link of aquima ui for the given session id.
      Parameters:
      sessionId - The current session id.
      Returns:
      the url link relative to the context path.

    • getThemes

      List<String> getThemes()
      This method returns the names of themes (css styles) for this AquimaUI.
      Returns:
      the names of the themes, never null.

    • hasCache

      boolean hasCache()
      This method indicated if the web renderer has a cache (that can be reset).
      Returns:
      boolean indicating if the renderer has a cache

    • resetCache

      boolean resetCache()
      This method may be called to reset the cache of this web render engine.
      Returns:
      boolean indicating if the cache has been reset.

    • getSourceContentType

      String getSourceContentType()
      This method returns the content type of the element source.
      Returns:
      The content type, may be null when the UI does not support source rendering.

    • writeSource

      void writeSource(com.aquima.interactions.composer.ICompositeElement element, IRenderContext context, Writer result) throws IOException
      This method may be used to write an elements source to a writer.
      Parameters:
      element - The page that should be rendered, may not be null.
      context - The render context containing some session information, may not be null.
      result - The destination writer, may not be null.
      Throws:
      IOException - When an error occurs writing to the result.