OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.BlockSearchSession
Implementsosid.hold.BlockQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

  • federated oubliette view: searches include blocks in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy
  • isolated oubliette view: searches are restricted to blocks in this oubliette

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

MethodgetBlockSearch
Description

Gets a block search.

Returnosid.hold.BlockSearchthe block search
CompliancemandatoryThis method must be implemented.
MethodgetBlockSearchOrder
Description

Gets a block search order. The BlockSearchOrder is supplied to a BlockSearch to specify the ordering of results.

Returnosid.hold.BlockSearchOrderthe block search order
CompliancemandatoryThis method must be implemented.
MethodgetBlocksBySearch
Description

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

Parametersosid.hold.BlockQueryblockQuerythe block query
osid.hold.BlockSearchblockSearchthe block search
Returnosid.hold.BlockSearchResultsthe block search results
ErrorsNULL_ARGUMENT blockQuery or blockSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED blockQuery or blockSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBlockQueryFromInspector
Description

Gets a block query from an inspector. The inspector is available from a BlockSearchResults.

Parametersosid.hold.BlockQueryInspectorblockQueryInspectora block query inspector
Returnosid.hold.BlockQuerythe block query
ErrorsNULL_ARGUMENT blockQueryInspector is null
UNSUPPORTED blockQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.