OSID Logo
OSID Specifications
relationship rules package
Version 3.0.0
Interfaceosid.relationship.rules.RelationshipEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.relationship.rules.RelationshipEnablerSearchSession
Description

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

MethodgetRelationshipEnablers
Description

Gets the RelationshipEnablerList resulting from a search.

Returnosid.relationship.rules.RelationshipEnablerListthe relationship enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipEnablerQueryInspector
Description

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

Returnosid.relationship.rules.RelationshipEnablerQueryInspectorthe relationship enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipEnablerSearchResultsRecord
Description

Gets the relationship enabler search results record corresponding to the given relationship enabler search record Type . This method must be used to retrieve an object implementing the requested record.

Parametersosid.type.TyperelationshipEnablerSearchRecordTypea relationship enabler search record type
Returnosid.relationship.rules.records.RelationshipEnablerSearchResultsRecordthe relationship enabler search results record
ErrorsNULL_ARGUMENTrelationshipEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTEDhasRecordType(relationshipEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.