OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.CheckSearchSession
Implementsosid.rules.check.CheckQuerySession
Description

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

getChecksByQuery() is the basic search method and returns a list of Checks. A more advanced search may be performed with getChecksBySearch(). It accepts a CheckSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getChecksBySearch() returns a CheckSearchResults that can be used to access the resulting CheckList or be used to perform a search within the result set through CheckSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetCheckSearch
Description

Gets a check search.

Returnosid.rules.check.CheckSearchthe check search
CompliancemandatoryThis method must be implemented.
MethodgetCheckSearchOrder
Description

Gets a check search order. The CheckSearchOrder is supplied to a CheckSearch to specify the ordering of results.

Returnosid.rules.check.CheckSearchOrderthe check search order
CompliancemandatoryThis method must be implemented.
MethodgetChecksBySearch
Description

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

Parametersosid.rules.check.CheckQuerycheckQuerythe check query
osid.rules.check.CheckSearchcheckSearchthe check search
Returnosid.rules.check.CheckSearchResultsthe check search results
ErrorsNULL_ARGUMENT checkQuery or checkSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED checkQuery or checkSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCheckQueryFromInspector
Description

Gets a check query from an inspector. The inspector is available from a CheckSearchResults.

Parametersosid.rules.check.CheckQueryInspectorcheckQueryInspectora check query inspector
Returnosid.rules.check.CheckQuerythe check query
ErrorsNULL_ARGUMENT checkQueryInspector is null
UNSUPPORTED checkQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.