Package com.novomind.ecom.api.iagent.persistence.storage

Interface StorageKeyInfo

All Superinterfaces:
com.novomind.ecom.common.api.attribute.DisplayNamed, com.novomind.ecom.common.api.attribute.Named
public interface StorageKeyInfo extends com.novomind.ecom.common.api.attribute.DisplayNamed
This interface provides additional information about the keys used in a Storage.
Since:
13.14

  • Method Details

    • getName

      String getName()
      Returns the name of this StorageKeyInfo which is the key in the associated Storage type. Please note that the same key may be used in different types of storages.
      Specified by:
      getName in interface com.novomind.ecom.common.api.attribute.Named
      Returns:
      the key in the associated Storage type.
      Since:
      13.14

    • getDisplayName

      String getDisplayName()
      Returns the display name of this StorageKeyInfo which contains a string representation of the Storage type and the key.
      Specified by:
      getDisplayName in interface com.novomind.ecom.common.api.attribute.DisplayNamed
      Returns:
      the display name of this StorageKeyInfo
      Since:
      13.14

    • getValueType

      IntermediateStorage.ValueType getValueType()
      Returns the IntermediateStorage.ValueType of the key in the Storage.
      Returns:
      the IntermediateStorage.ValueType of the key in the Storage
      Since:
      13.14

    • isHidden

      boolean isHidden()
      Returns true if the key should be hidden in the UI, otherwise false.
      Returns:
      true if the key should be hidden in the UI, otherwise false
      Since:
      13.14