OSID Logo
OSID Specifications
rules check package
Version 3.1.0
Interfaceosid.rules.check.AgendaSearchResults
Implementsosid.OsidSearchResults
Used Byosid.rules.check.AgendaSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetAgendas
Description

Gets the agenda list resulting from a search.

Returnosid.rules.check.AgendaList the agenda list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetAgendaQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.rules.check.AgendaQueryInspector the agenda query inspector
Compliancemandatory This method must be implemented.
MethodgetAgendaSearchResultsRecord
Description

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

Parametersosid.type.TypeagendaSearchRecordType an agenda search record type
Returnosid.rules.check.records.AgendaSearchResultsRecord the agenda search results record
ErrorsNULL_ARGUMENT agendaSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(agendaSearchRecordType) is false
Compliancemandatory This method must be implemented.