Package com.aquima.interactions.portal.model

Interface IApplicationStore

All Known Implementing Classes:
ApplicationStore
public interface IApplicationStore
Interface for objects that contain, or can load on demand, application definitions.
Since:
7.1
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    applicationExists(ApplicationID applicationId)
    This method returns whether an application exists for the specified application ID.
    ISolution
    getApplication(ApplicationID applicationId)
    This method returns the (cached) project for the specified ID.
    String[]
    getApplicationNames()
    This method returns an array with all the available application names.
    Version[]
    getApplicationVersions(String applicationName)
    This method returns an array containing all the versions that are available for a specific application.
    boolean
    resetCache(Version applicationsVersion, String[] applicationNames)
    This method may be invoked to reset the application cache for applications with a specific version.
    boolean
    resetCache(String applicationName)
    This method may be invoked to reset the application cache for a specific application.

  • Method Details

    • getApplicationNames

      String[] getApplicationNames()
      This method returns an array with all the available application names.
      Returns:
      an array with all the available application names.

    • getApplicationVersions

      Version[] getApplicationVersions(String applicationName)
      This method returns an array containing all the versions that are available for a specific application.
      Parameters:
      applicationName - The name of the application for which the versions are requested.
      Returns:
      Array containing all the versions that are available for a specific application.
      Throws:
      UnknownApplicationException - This exception is thrown when the application is unknown.

    • getApplication

      ISolution getApplication(ApplicationID applicationId)
      This method returns the (cached) project for the specified ID.
      Parameters:
      applicationId - The ID of the requested project.
      Returns:
      The project object for the specified ID.
      Throws:
      AppException - This exception is thrown when the application could not be retrieved.

    • applicationExists

      boolean applicationExists(ApplicationID applicationId)
      This method returns whether an application exists for the specified application ID. NOTE: In contrast to getApplication(ApplicationID) this does NOT load the application/project.
      Parameters:
      applicationId - The ID of the application/project that should be checked.
      Returns:
      True if the application exists, false otherwise

    • resetCache

      boolean resetCache(String applicationName)
      This method may be invoked to reset the application cache for a specific application.
      Parameters:
      applicationName - The name of the application for which the cache should be reset.
      Returns:
      False if the application does not exist, true otherwise

    • resetCache

      boolean resetCache(Version applicationsVersion, String[] applicationNames)
      This method may be invoked to reset the application cache for applications with a specific version.
      Parameters:
      applicationsVersion - The version for the applications to reset the cache for. Must NOT be null
      applicationNames - The applications (with this version) to reset the cache for. When null, reset the cache for all applications with this version
      Returns:
      False if the version does not exist for any of the applications to reset the cache for, true otherwise