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

Interface IntermediateStorage

  • All Known Subinterfaces:
    Storage
    public interface IntermediateStorage

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  IntermediateStorage.ValueType
      This enum represents the different value types for an IntermediateStorage.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean containsKey​(java.lang.String key)
      Checks if the storage has the given key
      java.lang.Object get​(java.lang.String key)
      Returns an Object value for the given key.
      java.lang.Boolean getBoolean​(java.lang.String key)
      Returns the Boolean value for the key
      java.util.Date getDate​(java.lang.String key)
      Returns the Date value for the key
      java.lang.Double getDouble​(java.lang.String key)
      Returns the Double value for the key
      java.lang.String getEncryptedString​(java.lang.String key)
      Returns the String value for the key.
      java.util.Set<java.lang.String> getKeySet()
      Returns a keyset of all set keys for the instance of this StorageProvider
      java.lang.Long getLong​(java.lang.String key)
      Returns the Long value for the key
      java.lang.String getString​(java.lang.String key)
      Returns the String value for the key
      IntermediateStorage.ValueType getValueType​(java.lang.String key)
      Returns the type of the value for the given key.
      java.lang.Object remove​(java.lang.String key)
      Removes the entry for the key
      IntermediateStorage setBoolean​(java.lang.String key, java.lang.Boolean value)
      Sets the KeyValue pair for this IntermediateStorage.
      IntermediateStorage setDate​(java.lang.String key, java.util.Date value)
      Sets the KeyValue pair for this IntermediateStorage.
      IntermediateStorage setDouble​(java.lang.String key, java.lang.Double value)
      Sets the KeyValue pair for this IntermediateStorage.
      IntermediateStorage setEncryptedString​(java.lang.String key, java.lang.String value)
      Sets the KeyValue pair for this IntermediateStorage.
      IntermediateStorage setLong​(java.lang.String key, java.lang.Long value)
      Sets the KeyValue pair for this IntermediateStorage.
      IntermediateStorage setString​(java.lang.String key, java.lang.String value)
      Sets the KeyValue pair for this IntermediateStorage.

    • Method Detail

      • setString

        IntermediateStorage setString​(java.lang.String key,
                              java.lang.String value)
                       throws WrongTypeException
        Sets the KeyValue pair for this IntermediateStorage. The value type is String.
        Parameters:
        key - the key
        value - the String value
        Returns:
        this IntermediateStorage instance
        Throws:
        WrongTypeException - is thrown when the type String is wrong for this key
        Since:
        11.0

      • setLong

        IntermediateStorage setLong​(java.lang.String key,
                            java.lang.Long value)
                     throws WrongTypeException
        Sets the KeyValue pair for this IntermediateStorage. The value type is Long.
        Parameters:
        key - the key
        value - the Long value
        Returns:
        this IntermediateStorage instance
        Throws:
        WrongTypeException - is thrown when the type Long is wrong for this key
        Since:
        11.0

      • setDouble

        IntermediateStorage setDouble​(java.lang.String key,
                              java.lang.Double value)
                       throws WrongTypeException
        Sets the KeyValue pair for this IntermediateStorage. The value type is Double.
        Parameters:
        key - the key
        value - the Double value
        Returns:
        this IntermediateStorage instance
        Throws:
        WrongTypeException - is thrown when the type Double is wrong for this key
        Since:
        11.0

      • setDate

        IntermediateStorage setDate​(java.lang.String key,
                            java.util.Date value)
                     throws WrongTypeException
        Sets the KeyValue pair for this IntermediateStorage. The value type is Date.
        Parameters:
        key - the key
        value - the Date value
        Returns:
        this IntermediateStorage instance
        Throws:
        WrongTypeException - is thrown when the type Date is wrong for this key
        Since:
        11.0

      • setBoolean

        IntermediateStorage setBoolean​(java.lang.String key,
                               java.lang.Boolean value)
                        throws WrongTypeException
        Sets the KeyValue pair for this IntermediateStorage. The value type is Boolean.
        Parameters:
        key - the key
        value - the Boolean value
        Returns:
        this IntermediateStorage instance
        Throws:
        WrongTypeException - is thrown when the type Boolean is wrong for this key
        Since:
        11.0

      • setEncryptedString

        IntermediateStorage setEncryptedString​(java.lang.String key,
                                       java.lang.String value)
                                throws WrongTypeException
        Sets the KeyValue pair for this IntermediateStorage. The value type is String. This string will be saved encrypted.
        Parameters:
        key - the key
        value - the String value
        Returns:
        this IntermediateStorage instance
        Throws:
        WrongTypeException - is thrown when the type String is wrong for this key or the type of the key is an unencrypted String
        Since:
        11.0

      • remove

        java.lang.Object remove​(java.lang.String key)
        Removes the entry for the key
        Parameters:
        key - the key
        Returns:
        the removed property
        Since:
        10.0.34

      • get

        java.lang.Object get​(java.lang.String key)
        Returns an Object value for the given key.
        Parameters:
        key - the key
        Returns:
        the value as an Object
        Since:
        10.0.34

      • getString

        java.lang.String getString​(java.lang.String key)
                    throws WrongTypeException
        Returns the String value for the key
        Parameters:
        key - the key
        Returns:
        the value as a String
        Throws:
        WrongTypeException - is thrown when the type String is wrong for this key
        Since:
        10.0.34

      • getLong

        java.lang.Long getLong​(java.lang.String key)
                throws WrongTypeException
        Returns the Long value for the key
        Parameters:
        key - the key
        Returns:
        the value as a Long
        Throws:
        WrongTypeException - is thrown when the type Long is wrong for this key
        Since:
        10.0.34

      • getDouble

        java.lang.Double getDouble​(java.lang.String key)
                    throws WrongTypeException
        Returns the Double value for the key
        Parameters:
        key - the key
        Returns:
        the value as a Double
        Throws:
        WrongTypeException - is thrown when the type Double is wrong for this key
        Since:
        10.0.34

      • getDate

        java.util.Date getDate​(java.lang.String key)
                throws WrongTypeException
        Returns the Date value for the key
        Parameters:
        key - the key
        Returns:
        the value as a Date
        Throws:
        WrongTypeException - is thrown when the type Date is wrong for this key
        Since:
        10.0.34

      • getBoolean

        java.lang.Boolean getBoolean​(java.lang.String key)
                      throws WrongTypeException
        Returns the Boolean value for the key
        Parameters:
        key - the key
        Returns:
        the value as a Boolean
        Throws:
        WrongTypeException - is thrown when the type Boolean is wrong for this key
        Since:
        10.0.34

      • getEncryptedString

        java.lang.String getEncryptedString​(java.lang.String key)
                             throws WrongTypeException
        Returns the String value for the key. This value will be decrypted.
        Parameters:
        key - the key
        Returns:
        the decrypted value as a String
        Throws:
        WrongTypeException - is thrown when the type String is wrong for this key or the type of the key is an unencrypted String
        Since:
        10.0.102

      • getKeySet

        java.util.Set<java.lang.String> getKeySet()
        Returns a keyset of all set keys for the instance of this StorageProvider
        Returns:
        the keys in a Set
        Since:
        10.0.34

      • containsKey

        boolean containsKey​(java.lang.String key)
        Checks if the storage has the given key
        Parameters:
        key - the key
        Returns:
        true if the storage has the given key, otherwise false
        Since:
        10.0.112

      • getValueType

        IntermediateStorage.ValueType getValueType​(java.lang.String key)
        Returns the type of the value for the given key.
        Parameters:
        key - the key
        Returns:
        The ValueType of the given key defined by this IntermediateStorage. If the value type is not defined the return value is null.
        Since:
        11.22.0