| Interface | osid.process.ProcessSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getProcesses | ||
| Description |
Gets the process list resulting from the search. | ||
| Return | osid.process.ProcessList | the process list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcessQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.process.ProcessQueryInspector | the process query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcessSearchResultsRecord | ||
| Description |
Gets the process search results record corresponding to
the given process search record | ||
| Parameters | osid.type.Type | processSearchRecordType | a process search record type |
| Return | osid.process.records.ProcessSearchResultsRecord | the process search results record | |
| Errors | NULL_ARGUMENT | processSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(processSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |