OSID Logo
OSID Specifications
search package
Version 3.0.0
Release Candidate Preview
Interfaceosid.search.Search
Implementsosid.OsidSearch
Description

The search interface for governing searches.

MethodorderResults
Description

Specify an ordering to the search results.

Parametersosid.search.SearchOrdersearchOrdersearch order
ErrorsNULL_ARGUMENT searchOrder is null
UNSUPPORTED searchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSearchRecord
Description

Gets the search record corresponding to the given search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypesearchRecordTypea search record type
Returnosid.search.records.SearchRecordthe search record
ErrorsNULL_ARGUMENT searchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(searchRecordType) is false
CompliancemandatoryThis method must be implemented.