Interface | osid.workflow.WorkSearchSession | ||
---|---|---|---|
Implements | osid.workflow.WorkQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Works may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getWorkSearch | ||
Description |
Gets a work search. | ||
Return | osid.workflow.WorkSearch | the work search | |
Compliance | mandatory | This method must be implemented. | |
Method | getWorkSearchOrder | ||
Description |
Gets a work search order. The | ||
Return | osid.workflow.WorkSearchOrder | the work search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getWorksBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.workflow.WorkQuery | workQuery | the work query |
osid.workflow.WorkSearch | workSearch | the work search | |
Return | osid.workflow.WorkSearchResults | the work search results | |
Errors | NULL_ARGUMENT | workQuery or workSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | workQuery or workSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkQueryFromInspector | ||
Description |
Gets a work query from an inspector. The inspector is
available from a | ||
Parameters | osid.workflow.WorkQueryInspector | workQueryInspector | a work query inspector |
Return | osid.workflow.WorkQuery | the work query | |
Errors | NULL_ARGUMENT | workQueryInspector is null | |
UNSUPPORTED | workQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |