OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
resourcing package
Version 3.0.0
Release Candidate Preview
| Interface | osid.resourcing.EffortSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getEfforts | ||
| Description |
Gets the effort list resulting from a search. | ||
| Return | osid.resourcing.EffortList | the effort list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEffortQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.resourcing.EffortQueryInspector | the effort query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEffortSearchResultsRecord | ||
| Description |
Gets the effort search results record corresponding to
the given effort search record | ||
| Parameters | osid.type.Type | effortSearchRecordType | an effort search record type |
| Return | osid.resourcing.records.EffortSearchResultsRecord | the effort search results record | |
| Errors | NULL_ARGUMENT | effortSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(effortSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |