OSID Logo
OSID Specifications
resource package
Version 3.1.0
Interfaceosid.resource.ResourceRelationshipSearchResults
Implementsosid.OsidSearchResults
Used Byosid.resource.ResourceRelationshipSearchSession
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.ResourceRelationshipList the resource relationship list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetResourceRelationshipQueryInspector
Description

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

Returnosid.resource.ResourceRelationshipQueryInspector the resource relationship query inspector
Compliancemandatory This 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.TyperesourceRelationshipSearchRecordType a resource relationship search record type
Returnosid.resource.records.ResourceRelationshipSearchResultsRecord the resource relationship search results record
ErrorsNULL_ARGUMENT resourceRelationshipSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(resourceRelationshipSearchRecordType) is false
Compliancemandatory This method must be implemented.