OSID Logo
OSID Specifications
resource package
Version 3.1.0
Interfaceosid.resource.ResourceSearch
Implementsosid.OsidSearch
Used Byosid.resource.ResourceSearchSession
Description

The search interface for governing resource searches.

MethodsearchAmongResources
Description

Execute this search among the given list of resources.

Parametersosid.id.IdListresourceIds list of resource Ids
ErrorsNULL_ARGUMENT resourceIds is null
Compliancemandatory This method must be implemented.
MethodorderResourceResults
Description

Specify an ordering to the search results.

Parametersosid.resource.ResourceSearchOrderresourceSearchOrder resource search order
ErrorsNULL_ARGUMENT order is null
UNSUPPORTED order is not of this service
Compliancemandatory This 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.TyperesourceSearchRecordType a resource search record type
Returnosid.resource.records.ResourceSearchRecord the resource search record
ErrorsNULL_ARGUMENT resourceSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordTypeType(resourceSearchRecordType) is false
Compliancemandatory This method must be implemented.