| Interface | osid.resourcing.FoundrySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getFoundries | ||
| Description |
Gets the foundry list resulting from a search. | ||
| Return | osid.resourcing.FoundryList | the foundry list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFoundryQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.resourcing.FoundryQueryInspector | the foundry query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFoundrySearchResultsRecord | ||
| Description |
Gets the foundry search results record corresponding to
the given foundry search record | ||
| Parameters | osid.type.Type | foundrySearchRecordType | a foundry search record type |
| Return | osid.resourcing.records.FoundrySearchResultsRecord | the foundry search results 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. | |