Interface | osid.logging.LogEntrySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing log entry searches. | ||
Method | searchAmongLogEntries | ||
Description |
Execute this search among the given list of log entries. | ||
Parameters | osid.id.IdList | logEntryIds | list of log entries |
Errors | NULL_ARGUMENT | logEntryIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderLogEntryResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.logging.LogEntrySearchOrder | logEntrySearchOrder | log entry search order |
Errors | NULL_ARGUMENT | logEntrySearchOrder is null | |
UNSUPPORTED | logEntrySearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntrySearchRecord | ||
Description |
Gets the log search record corresponding to the given
log entry search record | ||
Parameters | osid.type.Type | logEntrySearchRecordType | a log entry search record type |
Return | osid.logging.records.LogEntrySearchRecord | the log entry search 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. |