Interface | osid.tracking.FrontOfficeSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getFrontOffices | ||
Description |
Gets the front office list resulting from a search. | ||
Return | osid.tracking.FrontOfficeList | the front office list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficeQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.tracking.FrontOfficeQueryInspector | the front office query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficeSearchResultsRecord | ||
Description |
Gets the fromt office search results record
corresponding to the given front office search record
| ||
Parameters | osid.type.Type | frontOfficeSearchRecordType | a front office search record type |
Return | osid.tracking.records.FrontOfficeSearchResultsRecord | the front office search results record | |
Errors | NULL_ARGUMENT | frontOfficeSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(frontOfficeSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |