OSID Logo
OSID Specifications
offering package
Version 3.0.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.CanonicalUnitListthe canonical unit list
ErrorsILLEGAL_STATEthe list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitQueryInspector
Description

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

Returnosid.offering.CanonicalUnitQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypecanonicalUnitSearchRecordTypea canonical unit search record type
Returnosid.offering.records.CanonicalUnitSearchResultsRecordthe canonical unit search results record
ErrorsNULL_ARGUMENTcanonicalUnitSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(canonicalUnitSearchRecordType) is false
CompliancemandatoryThis method must be implemented.