OSID Logo
OSID Specifications
resource package
Version 3.1.0
Interfaceosid.resource.ResourceRelationshipSearch
Implementsosid.OsidSearch
Used Byosid.resource.ResourceRelationshipSearchSession
Description

ResourceRelationshipSearch defines the interface for specifying relationship search options.

MethodsearchAmongResourceRelationships
Description

Execute this search among the given list of resource relationships.

Parametersosid.id.IdListresourceRelationshipIds list of resource relationships
ErrorsNULL_ARGUMENT resourceRelationshipIds is null
Compliancemandatory This method must be implemented.
MethodorderResourceRelationshipResults
Description

Specify an ordering to the search results.

Parametersosid.resource.ResourceRelationshipSearchOrderresourceRelationshipSearchOrder relationship search order
ErrorsNULL_ARGUMENT resourceRelationshipSearchOrder is null
UNSUPPORTED resourceRelationshipSearchOrder is not of this service
Compliancemandatory This 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.TyperesourceRelationshipSearchRecordType a resource relationship search record type
Returnosid.resource.records.ResourceRelationshipSearchRecord the resource relationship search record
ErrorsNULL_ARGUMENT resourceRelationshipSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(resourceRelationshipSearchRecordType) is false
Compliancemandatory This method must be implemented.