package com.sourceforge.jpatterns.patterns.config;

 import com.sourceforge.jpatterns.core.configuration.exceptions.JPConfigException;

 import com.sourceforge.jpatterns.patterns.IJPattern;

 /**

  * This interface defines the configuration patterns. It would be used just for the retrieving different not factory specific configuration

  * information. It would have all the facilities <strong>factory</strong> has - scopes and priorities supports, lots of possible compinations to be

  * configured - just single name<>value configs, maps with the name of the group and lots of keys<>values etc.

  * <br/>

  * todo [zmicer]: please extend the interface with all the possible methods user may need for this.

  * todo [zmicer]: provide example of the configuration for each method.

  * <p/>

  * $Author::                    $<br/>

  * $Rev::                       $<br/>

  * $Date::                      $<br/>

  */

 public interface IJPConfig extends IJPattern

 {

     /**

      * Get the value using the key provided. It is the simplest form of this config pattern, still if to remember about the scopes and names - it

      * provides lots of usefull facilities.

      *

      * @param key   the key using which we should obtain the value

      *              Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      * @param scope the scope to be used

      *              Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      *

      * @return the necessary value to be retrieved. Nul won't be retrieved here as the JPConfigException would be thrown

      *

      * @throws JPConfigException would be thrown in the case of smth. wrong with the configuration. Please be noticed it could be

      *                           <code>JPConsumerConfigException and JPFrameworkConfigException</code>

      */

     String getValue(final String key, final String scope) throws JPConfigException;

 }