OSID Logo
OSID Specifications
relationship package
Version 3.1.0
Interfaceosid.relationship.RelationshipSearchResults
Implementsosid.OsidSearchResults
Used Byosid.relationship.RelationshipSearchSession
Description

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

MethodgetRelationships
Description

Gets the relationship list resulting from a search.

Returnosid.relationship.RelationshipList the relationship list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetRelationshipQueryInspector
Description

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

Returnosid.relationship.RelationshipQueryInspector the relationship query inspector
Compliancemandatory This method must be implemented.
MethodgetRelationshipSearchResultsRecord
Description

Gets the relationship search results record corresponding to the given relationship search record Type.This method must be used to retrieve an object implementing the requested record interface along with all of its ancestor interfaces.

Parametersosid.type.TyperelationshipSearchRecordType a relationship search record type
Returnosid.relationship.records.RelationshipSearchResultsRecord the relationship search results record
ErrorsNULL_ARGUMENT relationshipSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(relationshipSearchRecordType) is false
Compliancemandatory This method must be implemented.