OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.AgendaSearchSession
Implementsosid.rules.check.AgendaQuerySession
Description

This session provides methods for searching among Agenda objects. The search query is constructed using the AgendaQuery.

getAgendasByQuery() is the basic search method and returns a list of Agendas. A more advanced search may be performed with getAgendasBySearch(). It accepts an AgendaSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAgendasBySearch() returns an AgendaSearchResults that can be used to access the resulting AgendaList or be used to perform a search within the result set through AgendaSearch.

This session defines views that offer differing behaviors for searching.

  • federated engine view: searches include agendas in engines of which this engine is an ancestor in the engine hierarchy
  • isolated engine view: searches are restricted to agendas in this engine

Agendas may have a query record indicated by their respective record types. The query record is accessed via the AgendaQuery.

MethodgetAgendaSearch
Description

Gets an agenda search.

Returnosid.rules.check.AgendaSearchthe agenda search
CompliancemandatoryThis method must be implemented.
MethodgetAgendaSearchOrder
Description

Gets an agenda search order. The AgendaSearchOrder is supplied to an AgendaSearch to specify the ordering of results.

Returnosid.rules.check.AgendaSearchOrderthe agenda search order
CompliancemandatoryThis method must be implemented.
MethodgetAgendasBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.rules.check.AgendaQueryagendaQuerythe agenda query
osid.rules.check.AgendaSearchagendaSearchthe agenda search
Returnosid.rules.check.AgendaSearchResultsthe agenda search results
ErrorsNULL_ARGUMENT agendaQuery or agendaSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED agendaQuery or agendaSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAgendaQueryFromInspector
Description

Gets an agenda query from an inspector. The inspector is available from an AgendaSearchResults.

Parametersosid.rules.check.AgendaQueryInspectoragendaQueryInspectoran agenda query inspector
Returnosid.rules.check.AgendaQuerythe agenda query
ErrorsNULL_ARGUMENT agendaQueryInspector is null
UNSUPPORTED agendaQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.