Interface ToolInterface

Interface for tools used in dispatche module

Namespace: DispatchModule\Tools
Located at DispatchModule/ToolInterface.php

Methods summary
`public boolean`	# `addCriteria( string $name, mixed $value )` Adds search criteria Adds search criteria Parameters `$name` `$value` Returns boolean
`public boolean`	# `used( )` Tells whether any sequence is set Tells whether any sequence is set Returns boolean
`public ResultSet`	# `execute( )` Executes query Executes query Returns ResultSet
`public array`	# `getWantedParameters( )` Get parameters, that tool wants Get parameters, that tool wants Returns array array of wanted parameters (indexed by its name)
`public boolean`	# `requireParameter( string $parameter )` Indicates, whether tool needs parameter with specified name Indicates, whether tool needs parameter with specified name Parameters `$parameter` name Returns boolean true, if specified parameter is required by the tool
`public string`	# `getName( )` Gets lowercase tool class name without postfix (so for "BaseTool", "base" is returned) Gets lowercase tool class name without postfix (so for "BaseTool", "base" is returned) Returns string lowercased tool name without postfix
`public string`	# `getLabel( )` Gets human-readable short description (name) of the tool Gets human-readable short description (name) of the tool Returns string human-readable short description of the tools