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

The search interface for governing resource searches.

MethodsearchAmongResources
Description

Execute this search among the given list of resources.

Parametersosid.id.IdListresourceIdslist of resource Ids
ErrorsNULL_ARGUMENT resourceIds is null
CompliancemandatoryThis method must be implemented.
MethodorderResourceResults
Description

Specify an ordering to the search results.

Parametersosid.resource.ResourceSearchOrderresourceSearchOrderresource search order
ErrorsNULL_ARGUMENT order is null
UNSUPPORTED order is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetResourceSearchRecord
Description

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

Parametersosid.type.TyperesourceSearchRecordTypea resource search record type
Returnosid.resource.records.ResourceSearchRecordthe resource search record
ErrorsNULL_ARGUMENT resourceSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(resourceSearchRecordType) is false
CompliancemandatoryThis method must be implemented.