OSID Logo
OSID Specifications
relationship package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.RelationshipSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetRelationships
Description

Gets the relationship list resulting from a search.

Returnosid.relationship.RelationshipListthe relationship list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipQueryInspector
Description

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

Returnosid.relationship.RelationshipQueryInspectorthe relationship query inspector
CompliancemandatoryThis 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.TyperelationshipSearchRecordTypea relationship search record type
Returnosid.relationship.records.RelationshipSearchResultsRecordthe relationship search results record
ErrorsNULL_ARGUMENT relationshipSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(relationshipSearchRecordType) is false
CompliancemandatoryThis method must be implemented.