OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.ResourceRelationshipSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetResourceRelationships
Description

Gets the resource relationship list resulting from the search.

Returnosid.resource.ResourceRelationshipListthe resource relationship list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetResourceRelationshipQueryInspector
Description

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

Returnosid.resource.ResourceRelationshipQueryInspectorthe resource relationship query inspector
CompliancemandatoryThis method must be implemented.
MethodgetResourceRelationshipSearchResultsRecord
Description

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

Parametersosid.type.TyperesourceRelationshipSearchRecordTypea resource relationship search record type
Returnosid.resource.records.ResourceRelationshipSearchResultsRecordthe resource relationship search results record
ErrorsNULL_ARGUMENT resourceRelationshipSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(resourceRelationshipSearchRecordType) is false
CompliancemandatoryThis method must be implemented.