OSID Logo
OSID Specifications
relationship rules package
Version 3.1.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.RelationshipEnablerList the relationship enabler list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetRelationshipEnablerQueryInspector
Description

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

Returnosid.relationship.rules.RelationshipEnablerQueryInspector the relationship enabler query inspector
Compliancemandatory This 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.TyperelationshipEnablerSearchRecordType a relationship enabler search record type
Returnosid.relationship.rules.records.RelationshipEnablerSearchResultsRecord the relationship enabler search results record
ErrorsNULL_ARGUMENT relationshipEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(relationshipEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.