| Interface | osid.resourcing.EffortSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing effort searches. | ||
| Method | searchAmongEfforts | ||
| Description |
Execute this search among the given list of efforts. | ||
| Parameters | osid.id.IdList | effortIds | list of efforts |
| Errors | NULL_ARGUMENT | effortIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderEffortResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.resourcing.EffortSearchOrder | effortSearchOrder | effort search order |
| Errors | NULL_ARGUMENT | effortSearchOrder is null | |
| UNSUPPORTED | effortSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getEffortSearchRecord | ||
| Description |
Gets the effort search record corresponding to the
given effort search record | ||
| Parameters | osid.type.Type | effortSearchRecordType | an effort search record type |
| Return | osid.resourcing.records.EffortSearchRecord | the effort search 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. | |