Interface | osid.resource.ResourceSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing resource searches. | ||
Method | searchAmongResources | ||
Description |
Execute this search among the given list of resources. | ||
Parameters | osid.id.IdList | resourceIds | list of resource Ids |
Errors | NULL_ARGUMENT | resourceIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderResourceResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.resource.ResourceSearchOrder | resourceSearchOrder | resource search order |
Errors | NULL_ARGUMENT | order is null | |
UNSUPPORTED | order is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getResourceSearchRecord | ||
Description |
Gets the resource search record corresponding to the
given resource search record | ||
Parameters | osid.type.Type | resourceSearchRecordType | a resource search record type |
Return | osid.resource.records.ResourceSearchRecord | the resource search record | |
Errors | NULL_ARGUMENT | resourceSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordTypeType(resourceSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |