OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.CanonicalUnitEnablerSearchSession
Implementsosid.offering.rules.CanonicalUnitEnablerQuerySession
Description

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

getCanonicalUnitEnablersByQuery() is the basic search method and returns a list of CanonicalUnitEnablers. A more advanced search may be performed with getCanonicalUnitEnablersBySearch(). It accepts a CanonicalUnitEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. getCanonicalUnitEnablersBySearch() returns a CanonicalUnitEnablerSearchResults that can be used to access the resulting CanonicalUnitEnablerList or be used to perform a search within the result set through CanonicalUnitEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetCanonicalUnitEnablerSearch
Description

Gets a canonical unit enabler search.

Returnosid.offering.rules.CanonicalUnitEnablerSearchthe canonical unit enabler search
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitEnablerSearchOrder
Description

Gets a canonical unit enabler search order. The CanonicalUnitEnablerSearchOrder is supplied to a CanonicalUnitEnablerSearch to specify the ordering of results.

Returnosid.offering.rules.CanonicalUnitEnablerSearchOrderthe canonical unit enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitEnablersBySearch
Description

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

Parametersosid.offering.rules.CanonicalUnitEnablerQuerycanonicalUnitEnablerQuerythe canonical unit enabler query
osid.offering.rules.CanonicalUnitEnablerSearchcanonicalUnitEnablerSearchthe canonical unit enabler search
Returnosid.offering.rules.CanonicalUnitEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT canonicalUnitEnablerQuery or canonicalUnitEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED canonicalUnitEnablerQuery or canonicalUnitEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitEnablerQueryFromInspector
Description

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

Parametersosid.offering.rules.CanonicalUnitEnablerQueryInspectorcanonicalUnitEnablerQueryInspectora canonical unit enabler query inspector
Returnosid.offering.rules.CanonicalUnitEnablerQuerythe canonical unit enabler query
ErrorsNULL_ARGUMENT canonicalUnitEnablerQueryInspector is null
UNSUPPORTED canonicalUnitEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.