OSID Logo
OSID Specifications
relationship rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.rules.RelationshipEnablerSearch
Implementsosid.OsidSearch
Description

The search interface for governing relationship enabler searches.

MethodsearchAmongRelationshipEnablers
Description

Execute this search among the given list of relationship enablers.

Parametersosid.id.IdListrelationshipEnablerIdslist of relationship enablers
ErrorsNULL_ARGUMENT relationshipEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRelationshipEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.relationship.rules.RelationshipEnablerSearchOrderrelationshipEnablerSearchOrderrelationship enabler search order
ErrorsNULL_ARGUMENT relationshipEnablerSearchOrder is null
UNSUPPORTED relationshipEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipEnablerSearchRecord
Description

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

Parametersosid.type.TyperelationshipEnablerSearchRecordTypea relationship enabler search record type
Returnosid.relationship.rules.records.RelationshipEnablerSearchRecordthe relationship enabler search record
ErrorsNULL_ARGUMENT relationshipEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(relationshipEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.