OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.FoundrySearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetFoundries
Description

Gets the foundry list resulting from a search.

Returnosid.resourcing.FoundryListthe foundry list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetFoundryQueryInspector
Description

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

Returnosid.resourcing.FoundryQueryInspectorthe foundry query inspector
CompliancemandatoryThis method must be implemented.
MethodgetFoundrySearchResultsRecord
Description

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

Parametersosid.type.TypefoundrySearchRecordTypea foundry search record type
Returnosid.resourcing.records.FoundrySearchResultsRecordthe foundry search results record
ErrorsNULL_ARGUMENT foundrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(foundrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.