OSID Logo
OSID Specifications
relationship package
Version 3.1.0
Interfaceosid.relationship.RelationshipSearch
Implementsosid.OsidSearch
Used Byosid.relationship.RelationshipSearchSession
Description

The search interface for governing relationship searches.

MethodsearchAmongRelationships
Description

Execute this search among the given list of relationships.

Parametersosid.id.IdListrelationshipIds list of relationships
ErrorsNULL_ARGUMENT relationshipIds is null
Compliancemandatory This method must be implemented.
MethodorderRelationshipResults
Description

Specify an ordering to the search results.

Parametersosid.relationship.RelationshipSearchOrderrelationshipSearchOrder relationship search order
ErrorsNULL_ARGUMENT relationshipSearchOrder is null
UNSUPPORTED relationshipSearchOrder is not of this service
Compliancemandatory This 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.TyperelationshipSearchRecordType a relationship search record type
Returnosid.relationship.records.RelationshipSearchRecord the relationship search record
ErrorsNULL_ARGUMENT relationshipSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(relationshipSearchRecordType) is false
Compliancemandatory This method must be implemented.