OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.OsidSearchResults
Implementsosid.OsidResult
Description

This interface provides a means to capture results of a search. An example of searching withina result set:

                     
                     
                     OsidSearch os = session.getObjectSearch();
                     
                     OsidQuery query;
                     query = session.getObjectQuery();
                     query.matchDescription("*food*", wildcardStringMatchType, true);
                     ObjectSearchResults results = session.getObjectBySearch(query, os);
                     
                     // get information about search
                     ObjectList objects = results.getObjects();
                     int size = results.getResultSize();
                     
                     SearchPerformanceRecord record = (SearchPerformanceRecord) results.getObjectSearchResultsRecord(performanceRecodType);
                     Duration duration = record.getTimeForSearch();
                     
                                 
                     
                
MethodgetResultSize
Description

Returns the size of a result set from a search query. This number serves as an estimate to provide feedback for refining search queries and may not be the number of elements available through an OsidList.

Returncardinalthe result size
CompliancemandatoryThis method must be implemented.