OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
workflow package
Version 3.0.0
Release Candidate Preview
| Interface | osid.workflow.OfficeSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getOffices | ||
| Description |
Gets the office list resulting from a search. | ||
| Return | osid.workflow.OfficeList | the office list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfficeQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.workflow.OfficeQueryInspector | the office query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfficeSearchResultsRecord | ||
| Description |
Gets the office search results record corresponding to
the given office search record | ||
| Parameters | osid.type.Type | officeSearchRecordType | a office search record type |
| Return | osid.workflow.records.OfficeSearchResultsRecord | the office search results record | |
| Errors | NULL_ARGUMENT | officeSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(officeSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |