File: /home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/search-reply.js
/**
*
* Allows the results of a preview to be sent to the preview requester.
*
* @module ScopeJS
* @class SearchReply
*/
function SearchReply(){}
SearchReply.prototype = {
/**
* Register new category and send it to the source of the query
* @method register_category
* @param id String id
* @param title String title
* @param icon String icon
* @param category_renderer CategoryRenderer
*/
register_category: function(String: id, String: title, String: icon, [optional] CategoryRenderer: category_renderer) {
},
/**
* Returns a previously registered category
* @method id
* @param id
*/
lookup_category: function(String: id) {
},
/**
* Sends a single result to the source of a query
* @method push
* @param result CategorisedResult
*/
push: function(CategorisedResult: result) {
},
/**
* Informs the source of a query that the query was terminated due to an error
* @method error
* @return error String error
*/
error: function(String: error) {
},
/**
* Informs the source of a query that the query results are complete
* @method finished
*/
finished: function() {
}
};