Fixed searched criteria handling #3

[core.git] / inc / classes / interfaces / criteria / class_Criteria.php

diff --git a/inc/classes/interfaces/criteria/class_Criteria.php b/inc/classes/interfaces/criteria/class_Criteria.php
index 86d9b36fd03ecb3179c4209d104f22dc7a735d16..d2cb532fe074fa4e939f0efbe2986627c5e0f9f6 100644 (file)
--- a/inc/classes/interfaces/criteria/class_Criteria.php
+++ b/inc/classes/interfaces/criteria/class_Criteria.php
@@ -37,6 +37,31 @@ interface Criteria extends FrameworkInterface {
         */
        function getWrapperConfigEntry ();
 
+       /**
+        * Checks whether given key is set
+        *
+        * @param       $criteriaType   Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude'
+        * @param       $criteriaKey    Criteria key
+        * @return      $isSet                  Whether key is set
+        */
+       function isKeySet ($criteriaType, $criteriaKey);
+
+       /**
+        * Checks whether given key is set for 'choice' type
+        *
+        * @param       $criteriaKey    Criteria key
+        * @return      $isSet                  Whether key is set
+        */
+       function isChoiceKeySet ($criteriaKey);
+
+       /**
+        * Checks whether given key is set for 'exclude' type
+        *
+        * @param       $criteriaKey    Criteria key
+        * @return      $isSet                  Whether key is set
+        */
+       function isExcludeKeySet ($criteriaKey);
+
        /**
         * Getter for criteria array
         *
@@ -101,14 +126,30 @@ interface Criteria extends FrameworkInterface {
        function addConfiguredCriteria ($criteriaKey, $configEntry, $criteriaType = 'default');
 
        /**
-        * Get criteria element or null if not found
+        * Get criteria element or FALSE if not found
         *
         * @param       $criteriaKey    The requested criteria key
         * @param       $criteriaType   Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude'
-        * @return      $value                  Whether the value of the critera or null
+        * @return      $value                  Whether the value of the critera or FALSE
         */
        function getCriteriaElemnent ($criteriaKey, $criteriaType = 'default');
 
+       /**
+        * Get criteria element or FALSE if not found for 'choice' type
+        *
+        * @param       $criteriaKey    The requested criteria key
+        * @return      $value                  Whether the value of the critera or FALSE
+        */
+       function getCriteriaChoiceElemnent ($criteriaKey);
+
+       /**
+        * Get criteria element or FALSE if not found for 'exclude' type
+        *
+        * @param       $criteriaKey    The requested criteria key
+        * @return      $value                  Whether the value of the critera or FALSE
+        */
+       function getCriteriaExcludeElemnent ($criteriaKey);
+
        /**
         * Checks whether given array entry matches
         *