OSID Logo
OSID Specifications
relationship rules package
Version 3.1.0
Interfaceosid.relationship.rules.RelationshipEnablerSearch
Implementsosid.OsidSearch
Used Byosid.relationship.rules.RelationshipEnablerSearchSession
Description

The search interface for governing relationship enabler searches.

MethodsearchAmongRelationshipEnablers
Description

Execute this search among the given list of relationship enablers.

Parametersosid.id.IdListrelationshipEnablerIds list of relationship enablers
ErrorsNULL_ARGUMENT relationshipEnablerIds is null
Compliancemandatory This method must be implemented.
MethodorderRelationshipEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.relationship.rules.RelationshipEnablerSearchOrderrelationshipEnablerSearchOrder relationship enabler search order
ErrorsNULL_ARGUMENT relationshipEnablerSearchOrder is null
UNSUPPORTED relationshipEnablerSearchOrder is not of this service
Compliancemandatory This 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.TyperelationshipEnablerSearchRecordType a relationship enabler search record type
Returnosid.relationship.rules.records.RelationshipEnablerSearchRecord the relationship enabler search record
ErrorsNULL_ARGUMENT relationshipEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(relationshipEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.