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

The search interface for governing relationship searches.

MethodsearchAmongRelationships
Description

Execute this search among the given list of relationships.

Parametersosid.id.IdListrelationshipIdslist of relationships
ErrorsNULL_ARGUMENT relationshipIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRelationshipResults
Description

Specify an ordering to the search results.

Parametersosid.relationship.RelationshipSearchOrderrelationshipSearchOrderrelationship search order
ErrorsNULL_ARGUMENT relationshipSearchOrder is null
UNSUPPORTED relationshipSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipSearchRecord
Description

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

Parametersosid.type.TyperelationshipSearchRecordTypea relationship search record type
Returnosid.relationship.records.RelationshipSearchRecordthe relationship search 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.