Interface | osid.workflow.WorkQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
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 | getOfficeId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Office Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOffice | ||
Description |
Gets the | ||
Return | osid.workflow.Office | the office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchWorks | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedOfficeView | ||
Description |
Federates the view for methods in this session. A federated view will include works in offices which are children of this office in the office hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedOfficeView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts searches to this office only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getWorkQuery | ||
Description |
Gets a work query. | ||
Return | osid.workflow.WorkQuery | the work query | |
Compliance | mandatory | This method must be implemented. | |
Method | getWorksByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.workflow.WorkQuery | workQuery | the work query |
Return | osid.workflow.WorkList | the returned WorkList | |
Errors | NULL_ARGUMENT | workQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | workQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |