OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.CanonicalUnitSearchSession
Implementsosid.offering.CanonicalUnitQuerySession
Description

This session provides methods for searching CanonicalUnit objects. The search query is constructed using the CanonicalUnitQuery. The canonical unit record Type also specifies the record for the canonical unit query.

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

This session defines views that offer differing behaviors for searching.

  • federated catalogue view: searches include canonical units in catalogues of which this catalogue is a ancestor in the catalogue hierarchy
  • isolated catalogue view: searches are restricted to canonical units in this catalogue

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

MethodgetCanonicalUnitSearch
Description

Gets a canonical unit search.

Returnosid.offering.CanonicalUnitSearchthe canonical unit search
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitSearchOrder
Description

Gets a canonical unit search order. The CanonicalUnitSearchOrder is supplied to a CanonicalUnitSearch to specify the ordering of results.

Returnosid.offering.CanonicalUnitSearchOrderthe canonical unit search order
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitsBySearch
Description

Gets the search results matching the given search.

Parametersosid.offering.CanonicalUnitQuerycanonicalUnitQuerythe canonical unit query
osid.offering.CanonicalUnitSearchcanonicalUnitSearchthe canonical unit search
Returnosid.offering.CanonicalUnitSearchResultsthe search results
ErrorsNULL_ARGUMENT canonicalUnitQuery or canonicalUnitSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED canonicalUnitQuery or canonicalUnitSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitQueryFromInspector
Description

Gets a canonical unit query from an inspector. The inspector is available from a CanonicalUnitSearchResults.

Parametersosid.offering.CanonicalUnitQueryInspectorcanonicalUnitQueryInspectora canonical unit query inspector
Returnosid.offering.CanonicalUnitQuerythe canonical unit query
ErrorsNULL_ARGUMENT canonicalUnitQueryInspector is null
UNSUPPORTED canonicalUnitQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.