OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.OfferingConstrainerEnablerSearchSession
Implementsosid.offering.rules.OfferingConstrainerEnablerQuerySession
Description

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

getOfferingConstrainerEnablersByQuery() is the basic search method and returns a list of OfferingConstrainerEnablers. A more advanced search may be performed with getOfferingConstrainerEnablersBySearch(). It accepts an OfferingConstrainerEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. getOfferingConstrainerEnablersBySearch() returns an OfferingConstrainerEnablerSearchResults that can be used to access the resulting OfferingConstrainerEnablerList or be used to perform a search within the result set through OfferingConstrainerEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetOfferingConstrainerEnablerSearch
Description

Gets an offering constrainer enabler search.

Returnosid.offering.rules.OfferingConstrainerEnablerSearchthe offering constrainer enabler search
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerEnablerSearchOrder
Description

Gets an offering constrainer enabler search order. The OfferingConstrainerEnablerSearchOrder is supplied to an OfferingConstrainerEnablerSearch to specify the ordering of results.

Returnosid.offering.rules.OfferingConstrainerEnablerSearchOrderthe offering constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerEnablersBySearch
Description

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

Parametersosid.offering.rules.OfferingConstrainerEnablerQueryofferingConstrainerEnablerQuerythe offering constrainer enabler query
osid.offering.rules.OfferingConstrainerEnablerSearchofferingConstrainerEnablerSearchthe offering constrainer enabler search
Returnosid.offering.rules.OfferingConstrainerEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT offeringConstrainerEnablerQuery or offeringConstrainerEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED offeringConstrainerEnablerQuery or offeringConstrainerEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerEnablerQueryFromInspector
Description

Gets an offering constrainer enabler query from an inspector. The inspector is available from an OfferingConstrainerEnablerSearchResults.

Parametersosid.offering.rules.OfferingConstrainerEnablerQueryInspectorofferingConstrainerEnablerQueryInspectoran offering constrainer enabler query inspector
Returnosid.offering.rules.OfferingConstrainerEnablerQuerythe offering constrainer enabler query
ErrorsNULL_ARGUMENT offeringConstrainerEnablerQueryInspector is null
UNSUPPORTED offeringConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.