Package com.appliedolap.essbase

Interface EssApplicationConfiguration

All Known Implementing Classes:
EssApplicationConfigurationImpl
public interface EssApplicationConfiguration
One application configuration setting - a key from Essbase's catalogue, what it is for, and the value this application gives it if any.

Reached through EssApplication.configuration(). A key exists whether or not it is set: the server publishes a fixed catalogue of them (64 on 26.1) with a description, a syntax and a worked example each, and an application configures whichever subset it needs. So this type stands for a key, and isConfigured() says whether this application has given it a value.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete()
    Removes this key from the application's configuration, leaving the setting at whatever default Essbase applies.
    EssApplication
    getApplication()
    Gets the application that this configuration item is associated with.
    String
    getDescription()
    What the setting does, in Essbase's own words.
    String
    getExample()
    A filled-in example, e.g.
    String
    getKey()
    Gets the key for this configuration property.
    String
    getSyntax()
    How the setting is written, e.g.
    String
    getValue()
    Gets the value for this configuration property, or null when this application doesn't set it.
    boolean
    isConfigured()
    Whether this application sets this key.
    EssApplicationConfiguration
    set(String value)
    Sets this key on the application, adding it if it wasn't there and replacing the value if it was.

  • Method Details

    • getApplication

      EssApplication getApplication()
      Gets the application that this configuration item is associated with.
      Returns:
      the parent application

    • getKey

      String getKey()
      Gets the key for this configuration property.
      Returns:
      the configuration key name

    • getValue

      String getValue()
      Gets the value for this configuration property, or null when this application doesn't set it.
      Returns:
      the configuration value, or null

    • getDescription

      String getDescription()
      What the setting does, in Essbase's own words.
      Returns:
      the description, or null for a key not in the server's catalogue

    • getSyntax

      String getSyntax()
      How the setting is written, e.g. DATACACHESIZE n or CALCCACHE [dbname] TRUE | FALSE. The square brackets and bars are Essbase's notation, not something to send.
      Returns:
      the syntax, or null

    • getExample

      String getExample()
      A filled-in example, e.g. DATACACHESIZE 90M. Worth showing beside the syntax, since the syntax alone rarely settles what a value should look like.
      Returns:
      the example, or null

    • isConfigured

      boolean isConfigured()
      Whether this application sets this key.

      Derived from whether the key appears among the application's configurations, and deliberately not from the server's own configured field, which is always false - including on the very keys returned by ?configured=true. A client trusting that field reports an application with settings as having none.

      Returns:
      true if this application gives the key a value

    • set

      EssApplicationConfiguration set(String value)
      Sets this key on the application, adding it if it wasn't there and replacing the value if it was.
      Parameters:
      value - the value, written as getSyntax() describes
      Returns:
      this setting as the server records it afterwards

    • delete

      void delete()
      Removes this key from the application's configuration, leaving the setting at whatever default Essbase applies.