Interface | osid.workflow.WorkSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getWorks | ||
Description |
Gets the work list resulting from a search. | ||
Return | osid.workflow.WorkList | the work list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getWorkQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.workflow.WorkQueryInspector | the work query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getWorkSearchResultsRecord | ||
Description |
Gets the work search results record corresponding to
the given work search record | ||
Parameters | osid.type.Type | workSearchRecordType | a work search record type |
Return | osid.workflow.records.WorkSearchResultsRecord | the work search results 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. |