ZMResultSource
public interface ZMResultSource
| Method Summary | |
|---|---|
| string | Get the class name of the results. |
| array | Get the results. |
| int | Total number of results. |
| boolean | isFinal() Indicates whether the returned results are final or not. |
| void | setResultList(ZMResultList resultList) Set the corresponding result list. |
public string getResultClass()
Get the class name of the results.
public array getResults()
Get the results.
public int getTotalNumberOfResults()
Total number of results.
public boolean isFinal()
Indicates whether the returned results are final or not.
Sources may opt to filter and sort results already (for example for performance reasons. In that case, no further action is required by the result list.
As a side effect, the method getAllResults() may then return the same
results (number and sort order) as getResults(), even if the source
reports more than one page.
true if the result source is handling all sorting and filtering, too.public void setResultList(ZMResultList resultList)
Set the corresponding result list.
A source of result list results.