OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.AgendaSearchResults
Implementsosid.OsidSearchResults
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.AgendaListthe agenda list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetAgendaQueryInspector
Description

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

Returnosid.rules.check.AgendaQueryInspectorthe agenda query inspector
CompliancemandatoryThis 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.TypeagendaSearchRecordTypean agenda search record type
Returnosid.rules.check.records.AgendaSearchResultsRecordthe agenda search results record
ErrorsNULL_ARGUMENT agendaSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(agendaSearchRecordType) is false
CompliancemandatoryThis method must be implemented.