Interface | osid.workflow.WorkSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing work searches. | ||
Method | searchAmongWorks | ||
Description |
Execute this search among the given list of works. | ||
Parameters | osid.id.IdList | workIds | list of works |
Errors | NULL_ARGUMENT | workIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderWorkResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.workflow.WorkSearchOrder | workSearchOrder | work search order |
Errors | NULL_ARGUMENT | workSearchOrder is null | |
UNSUPPORTED | workSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkSearchRecord | ||
Description |
Gets the work search record corresponding to the given
work search record | ||
Parameters | osid.type.Type | workSearchRecordType | a work search record type |
Return | osid.workflow.records.WorkSearchRecord | the work search record | |
Errors | NULL_ARGUMENT | workSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(workSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |