1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 

<?php

namespace DispatchModule\Tools;

/**
 * Interface for tools used in dispatche module
 */
interface ToolInterface {

    /**
     * Adds search criteria
     *
     * @param string $name
     * @param mixed $value
     * @return boolean
     */
    public function addCriteria($name, $value);

    /**
     * Tells whether any sequence is set
     * 
     * @return boolean
     */
    public function used();

    /**
     * Executes query
     * 
     * @return ResultSet
     */
    public function execute();

    /**
     * Get parameters, that tool wants
     *
     * @return array array of wanted parameters (indexed by its name)
     */
    public function getWantedParameters();

    /**
     * Indicates, whether tool needs parameter with specified name
     *
     * @param string parameter name
         * @return boolean true, if specified parameter is required by the tool
     */
    public function requireParameter($parameter);

    /**
     * Gets lowercase tool class name without postfix (so for "BaseTool", "base" is returned)
     *
     * @return string lowercased tool name without postfix
     */
    public function getName();

    /**
     * Gets human-readable short description (name) of the tool
     *
     * @return string human-readable short description of the tools
     */
    public function getLabel();
}