Interface | osid.logging.LogEntrySearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getLogEntries | ||
Description |
Gets the log entry list resulting from a search. | ||
Return | osid.logging.LogEntryList | the log entry list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntryQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.logging.LogEntryQueryInspector | the log entry query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntrySearchResultsRecord | ||
Description |
Gets the log entry search results record corresponding
to the given log entry search record | ||
Parameters | osid.type.Type | logEntrySearchRecordType | a log entry search record type |
Return | osid.logging.records.LogEntrySearchResultsRecord | the log entry search results record | |
Errors | NULL_ARGUMENT | logEntrySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(logEntrySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |