Rewrote search criteria matching:

[core.git] / inc / classes / interfaces / criteria / extended / class_LocalSearchCriteria.php

diff --git a/inc/classes/interfaces/criteria/extended/class_LocalSearchCriteria.php b/inc/classes/interfaces/criteria/extended/class_LocalSearchCriteria.php
index 7a768a1a8f6bb944c2e00e088a01144e9fd8ab57..32ccdcf71c91330b396a81357bbb2eeeaa1cd53e 100644 (file)
--- a/inc/classes/interfaces/criteria/extended/class_LocalSearchCriteria.php
+++ b/inc/classes/interfaces/criteria/extended/class_LocalSearchCriteria.php
@@ -22,6 +22,55 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 interface LocalSearchCriteria extends Criteria {
+       /**
+        * Setter for limit
+        *
+        * @param       $limit  Search limit
+        * @return      void
+        * @todo        Find a nice casting here. (int) allows until and including 32766.
+        */
+       function setLimit ($limit);
+
+       /**
+        * "Setter" for limit from a configuration entry
+        *
+        * @param       $configEntry    The configuration entry which hold a number as limit
+        * @return      void
+        */
+       function setConfiguredLimit ($configEntry);
+
+       /**
+        * Getter for limit
+        *
+        * @return      $limit  Search limit
+        */
+       function getLimit ();
+
+       /**
+        * Setter for skip
+        *
+        * @param       $skip   Search skip
+        * @return      void
+        * @todo        Find a nice casting here. (int) allows until and including 32766.
+        */
+       function setSkip ($skip);
+
+       /**
+        * Getter for skip
+        *
+        * @return      $skip   Search skip
+        */
+       function getSkip ();
+
+       /**
+        * Checks whether the given key/value pair is matching with 'default' and one of 'choice' and
+        * never with in 'exclude'.
+        *
+        * @param       $key                    Key element to check
+        * @param       $value                  Value to check
+        * @return      $isMatching             Whether the key/value is matching or excluded
+        */
+       function isCriteriaMatching ($key, $value);
 }
 
 // [EOF]