Package com.novomind.ecom.api.iagent.model

Interface App

  • All Superinterfaces:
    com.novomind.ecom.common.api.attribute.Named, StorageProvider
    public interface App
extends com.novomind.ecom.common.api.attribute.Named, StorageProvider
    Represents an App object
    Since:
    10.0.34

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getAppId()
      Returns the id of this app
      Storage getConfig()
      Returns the configuration of this app.
      java.lang.String getGroupId()
      Returns the id of the group of this app
      java.lang.String getUid()
      Returns the unique id of this app.
      java.lang.String getVendor()
      Returns the vendor of this app
      java.lang.String getVersion()
      Returns the version of this app

      • Methods inherited from interface com.novomind.ecom.common.api.attribute.Named

        getName

    • Method Detail

      • getGroupId

        java.lang.String getGroupId()
        Returns the id of the group of this app
        Returns:
        the id of the group of this app as String
        Since:
        10.0.34

      • getAppId

        java.lang.String getAppId()
        Returns the id of this app
        Returns:
        the id of this app as String
        Since:
        10.0.34

      • getUid

        java.lang.String getUid()
        Returns the unique id of this app. It is a combination of the groupId and the appId.
        Returns:
        the unique id of this app as String
        Since:
        10.0.34

      • getVersion

        java.lang.String getVersion()
        Returns the version of this app
        Returns:
        the version of this app as String
        Since:
        10.0.34

      • getVendor

        java.lang.String getVendor()
        Returns the vendor of this app
        Returns:
        the vendor of this app as String
        Since:
        10.0.34

      • getConfig

        Storage getConfig()
           throws PersistencyException

        Returns the configuration of this app.

        The configuration keys are defined in the app manifest xml file.
        They are available after the first configuration e.g. via the supervisor administration.
        The following table maps the data types from the manifest xml to the available storage methods:

        data type mappings
        data typestorage method
        StringgetString
        EncryptedStringgetEncryptedString
        BooleangetBoolean
        LonggetLong
        DoublegetDouble
        DategetDate
        Returns:
        the configuration of this app as Storage
        Throws:
        PersistencyException - is thrown if an error occurs during the initialization of the Storage
        Since:
        10.0.34