/*

 Copyright: Meticube, Portugal, 2008. 

 This software is licensed under the CC-GNU GPL.  See http://creativecommons.org/licenses/GPL/2.0/ for

 human-readable Commons Deed, lawyer-readable legal code, and machine-readable digital code.

 Note: This file is based on the UCH 1.0 specification of the URC Consortium, http://myurc.org/TR/uch1.0/.

*/

using System;
using System.Collections.Generic;
using System.Text;

namespace org.myurc.uch.Interfaces.UCHStore
{
    /// <summary>
    /// UCH store works as a storage point for TAs, TDMs and UIPMs
    /// </summary>
    public interface IUCHStore
    {

        /// <summary>
        /// Get a stored value from the local UCH store 
        /// </summary>
        /// <param name="key">Key (string) for the value</param>
        /// <returns>Value stored under the given key.  The caller may need to cast the returned object into the correct type.  The return value is NULL if no entry exists for the given key.</returns>
        object getValue(string key);

        /// <summary>
        /// Set a (new) value for the given key. If the key didn’t exist in the map before, it will be created.  If the key is already existing, the map stores the new value under the key, and the old value is removed.
        /// </summary>
        /// <param name="key">Key (string) for the value</param>
        /// <param name="value"></param>
        void setValue(string key, object value);
    }
}