Interface | osid.resourcing.FoundrySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing foundry searches. | ||
Method | searchAmongFoundries | ||
Description |
Execute this search among the given list of foundries. | ||
Parameters | osid.id.IdList | foundryIds | list of foundries |
Errors | NULL_ARGUMENT | foundryIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderFoundryResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.resourcing.FoundrySearchOrder | foundrySearchOrder | foundry search order |
Errors | NULL_ARGUMENT | foundrySearchOrder is null | |
UNSUPPORTED | foundrySearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFoundrySearchRecord | ||
Description |
Gets the foundry search record corresponding to the
given foundry search record | ||
Parameters | osid.type.Type | foundrySearchRecordType | a foundry search record type |
Return | osid.resourcing.records.FoundrySearchRecord | the foundry search record | |
Errors | NULL_ARGUMENT | foundrySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(foundrySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |