OSID Logo
OSID Specifications
offering package
Version 3.1.0
Interfaceosid.offering.CanonicalUnitSearchResults
Implementsosid.OsidSearchResults
Used Byosid.offering.CanonicalUnitSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetCanonicalUnits
Description

Gets the canonical unit list resulting from a search.

Returnosid.offering.CanonicalUnitList the canonical unit list
ErrorsILLEGAL_STATE the list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetCanonicalUnitQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.offering.CanonicalUnitQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetCanonicalUnitSearchResultsRecord
Description

Gets the record corresponding to the given canonical unit search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypecanonicalUnitSearchRecordType a canonical unit search record type
Returnosid.offering.records.CanonicalUnitSearchResultsRecord the canonical unit search results record
ErrorsNULL_ARGUMENT canonicalUnitSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(canonicalUnitSearchRecordType) is false
Compliancemandatory This method must be implemented.