Package com.axemble.vdoc.sdk.interfaces

Interface IConfiguration

All Superinterfaces:
IElement, Serializable
public interface IConfiguration extends IElement
The IConfiguration interface represents a configuration of a ICatalog object.
Since:
1.0, 15/04/2008
Author:
vlygeros
See Also:

  • Method Details

    • getProperty

      @Deprecated String getProperty(String key)
      Deprecated.
      use getStringProperty() method instead.
      Retrieves a standard property by passing its key

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      Returns:
      A string value

    • getBooleanProperty

      boolean getBooleanProperty(String key)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      Returns:
      A boolean value

    • getBooleanProperty

      boolean getBooleanProperty(String key, boolean defaultValue)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A bool value

    • getDoubleProperty

      double getDoubleProperty(String key)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      Returns:
      A double value

    • getDoubleProperty

      double getDoubleProperty(String key, double defaultValue)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A double value

    • getBigDecimalProperty

      BigDecimal getBigDecimalProperty(String key)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      Returns:
      A BigDecimal value

    • getBigDecimalProperty

      BigDecimal getBigDecimalProperty(String key, BigDecimal defaultValue)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A BigDecimal value

    • getFloatProperty

      float getFloatProperty(String key)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      Returns:
      A float value

    • getFloatProperty

      float getFloatProperty(String key, float defaultValue)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A float value

    • getIntegerProperty

      int getIntegerProperty(String key)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      Returns:
      A int value

    • getIntegerProperty

      int getIntegerProperty(String key, int defaultValue)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A int value

    • getLongProperty

      long getLongProperty(String key)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      Returns:
      A long value

    • getLongProperty

      long getLongProperty(String key, long defaultValue)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A long value

    • getStringProperty

      String getStringProperty(String key)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      Returns:
      A String value

    • getStringProperty

      String getStringProperty(String key, String defaultValue)
      Retrieves a standard property by passing its key.

      The system will search, first on the server level, and finally in the *.properties files.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A String value

    • getStringArrayProperty

      String[] getStringArrayProperty(String key)
      Retrieves standard property values by passing its key.
      Parameters:
      key - The key string.
      Returns:
      An array of String objects.

    • getProperties

      Properties getProperties()
      Retrieves all standard properties
      Returns:
      A Properties object

    • getUserProperty

      @Deprecated String getUserProperty(String key)
      Deprecated.
      use getStringUserProperty() method instead.
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      Returns:
      A string value

    • getBooleanUserProperty

      boolean getBooleanUserProperty(String key)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      Returns:
      A bool value

    • getBooleanUserProperty

      boolean getBooleanUserProperty(String key, boolean defaultValue)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A bool value

    • getDoubleUserProperty

      double getDoubleUserProperty(String key)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      Returns:
      A double value

    • getDoubleUserProperty

      double getDoubleUserProperty(String key, double defaultValue)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A double value

    • getBigDecimalUserProperty

      BigDecimal getBigDecimalUserProperty(String key)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      Returns:
      A BigDecimal value

    • getBigDecimalUserProperty

      BigDecimal getBigDecimalUserProperty(String key, BigDecimal defaultValue)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A BigDecimal value

    • getFloatUserProperty

      float getFloatUserProperty(String key)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      Returns:
      A float value

    • getFloatUserProperty

      float getFloatUserProperty(String key, float defaultValue)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A float value

    • getIntegerUserProperty

      int getIntegerUserProperty(String key)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      Returns:
      A int value

    • getIntegerUserProperty

      int getIntegerUserProperty(String key, int defaultValue)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A int value

    • getLongUserProperty

      long getLongUserProperty(String key)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      Returns:
      A long value

    • getLongUserProperty

      long getLongUserProperty(String key, long defaultValue)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A long value

    • getObjectUserProperty

      Object getObjectUserProperty(String key)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      Returns:
      A Object value

    • getObjectUserProperty

      Object getObjectUserProperty(String key, Object defaultValue)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A Object value

    • getStringUserProperty

      String getStringUserProperty(String key)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      Returns:
      A String value

    • getStringUserProperty

      String getStringUserProperty(String key, String defaultValue)
      Retrieves a specific property by passing its key.

      The properties can be specified in the 'User parameters' either on the server or a catalog.

      The system will search, first on the catalog level, then on the server level.

      Parameters:
      key - The key string
      defaultValue - The default value
      Returns:
      A String value

    • getUserProperties

      Properties getUserProperties()
      Retreves all specific properties
      Returns:
      A Properties object

    • getCustomFile

      InputStream getCustomFile(String... path) throws IOException
      give read access to a file inside the vdoc.ear/vdoc.war/WEB-INF/storage/custom
      Parameters:
      path - the custom folder sub paths
      Returns:
      An input stream for reading the resource, or null if the resource could not be found
      Throws:
      IOException - IOException

    • getWARFolder

      @Deprecated Path getWARFolder()
      Deprecated.
      get the WAR folder absolute path.
      This is deprecated because JEE specification don't allow Java file API.
      Returns:
      the WAR folder absolute path

    • getCustomFolder

      @Deprecated Path getCustomFolder(String... path)
      Deprecated.
      get a custom sub folder absolute path.
      This is deprecated because JEE specification don't allow Java file API.
      Parameters:
      path - the custom folder sub paths
      Returns:
      the custom sub folder absolute path

    • getProductVersion

      IVersion getProductVersion()
      Returns:
      an IVersion corresponding to the running moovapps-process version