OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.ResourceRelationshipSearch
Implementsosid.OsidSearch
Description

ResourceRelationshipSearch defines the interface for specifying relationship search options.

MethodsearchAmongResourceRelationships
Description

Execute this search among the given list of resource relationships.

Parametersosid.id.IdListresourceRelationshipIdslist of resource relationships
ErrorsNULL_ARGUMENT resourceRelationshipIds is null
CompliancemandatoryThis method must be implemented.
MethodorderResourceRelationshipResults
Description

Specify an ordering to the search results.

Parametersosid.resource.ResourceRelationshipSearchOrderresourceRelationshipSearchOrderrelationship search order
ErrorsNULL_ARGUMENT resourceRelationshipSearchOrder is null
UNSUPPORTED resourceRelationshipSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetResourceRelationshipSearchRecord
Description

Gets the resource 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.TyperesourceRelationshipSearchRecordTypea resource relationship search record type
Returnosid.resource.records.ResourceRelationshipSearchRecordthe resource relationship search record
ErrorsNULL_ARGUMENT resourceRelationshipSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(resourceRelationshipSearchRecordType) is false
CompliancemandatoryThis method must be implemented.