OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.OfferingSearchSession
Implementsosid.offering.OfferingQuerySession
Description

This session provides methods for searching Offering objects. The search query is constructed using the OfferingQuery. The offering record Type also specifies the record for the offering query.

getOfferingsByQuery() is the basic search method and returns a list of Offering elements. A more advanced search may be performed with getOfferingsBySearch(). It accepts an OfferingSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getOfferingsBySearch() returns an OfferingSearchResults that can be used to access the resulting OfferingList or be used to perform a search within the result set through OfferingSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetOfferingSearch
Description

Gets an offering search.

Returnosid.offering.OfferingSearchthe offering search
CompliancemandatoryThis method must be implemented.
MethodgetOfferingSearchOrder
Description

Gets an offering search order. The OfferingSearchOrder is supplied to an OfferingSearch to specify the ordering of results.

Returnosid.offering.OfferingSearchOrderthe offering search order
CompliancemandatoryThis method must be implemented.
MethodgetOfferingsBySearch
Description

Gets the search results matching the given search.

Parametersosid.offering.OfferingQueryofferingQuerythe offering query
osid.offering.OfferingSearchofferingSearchthe offering search
Returnosid.offering.OfferingSearchResultsthe search results
ErrorsNULL_ARGUMENT offeringQuery or offeringSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED offeringQuery or offeringSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetOfferingQueryFromInspector
Description

Gets an offering query from an inspector. The inspector is available from an OfferingSearchResults.

Parametersosid.offering.OfferingQueryInspectorofferingQueryInspectoran offering query inspector
Returnosid.offering.OfferingQuerythe offering query
ErrorsNULL_ARGUMENT offeringQueryInspector is null
UNSUPPORTED offeringQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.