OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.AgendaSearch
Implementsosid.OsidSearch
Description

The search interface for governing agenda searches.

MethodsearchAmongAgendas
Description

Execute this search among the given list of agendas.

Parametersosid.id.IdListagendaIdslist of agendas
ErrorsNULL_ARGUMENT agendaIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAgendaResults
Description

Specify an ordering to the search results.

Parametersosid.rules.check.AgendaSearchOrderagendaSearchOrderagenda search order
ErrorsNULL_ARGUMENT agendaSearchOrder is null
UNSUPPORTED agendaSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAgendaSearchRecord
Description

Gets the agenda search 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.AgendaSearchRecordthe agenda search 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.