OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.CatalogueSearchSession
Implementsosid.offering.CatalogueQuerySession
Description

This session provides methods for searching Catalogue objects. The search query is constructed using the CatalogueQuery. The catalogue record Type also specifies the catalogue query record for the catalogue query.

getCataloguesByQuery() is the basic search method and returns a list of Catalogue elements. A more advanced search may be performed with getCataloguesBySearch(). It accepts a CatalogueSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getCataloguesBySearch() returns a CatalogueSearchResults that can be used to access the resulting CatalogueList or be used to perform a search within the result set through CatalogueSearch.

Catalogues may have a query record indicated by their respective record types. The query record is accessed via the CatalogueQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetCatalogueSearch
Description

Gets a catalogue search.

Returnosid.offering.CatalogueSearchthe catalogue search
CompliancemandatoryThis method must be implemented.
MethodgetCatalogueSearchOrder
Description

Gets a catalogue search order. The CatalogueSearchOrder is supplied to a CatalogueSearch to specify the ordering of results.

Returnosid.offering.CatalogueSearchOrderthe catalogue search order
CompliancemandatoryThis method must be implemented.
MethodgetCataloguesBySearch
Description

Gets the search results matching the given search.

Parametersosid.offering.CatalogueQuerycatalogueQuerythe catalogue query
osid.offering.CatalogueSearchcatalogueSearchthe catalogue search
Returnosid.offering.CatalogueSearchResultsthe search results
ErrorsNULL_ARGUMENT catalogueQuery or catalogueSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED catalogueQuery or catalogueSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCatalogueQueryFromInspector
Description

Gets a catalogue query from an inspector. The inspector is available from a CatalogueSearchResults.

Parametersosid.offering.CatalogueQueryInspectorcatalogueQueryInspectora catalogue query inspector
Returnosid.offering.CatalogueQuerythe catalogue query
ErrorsNULL_ARGUMENT catalogueQueryInspector is null
UNSUPPORTED icatalogueQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.