public interface LogAPI
The stored logs depend on which bonita objects have been enabled for logging (this is configurable in bonita-home configuration files)
Modifier and Type | Method and Description |
---|---|
Log |
getLog(long logId)
Retrieves the log.
|
List<Log> |
getLogs(int startIndex,
int maxResults,
LogCriterion criterion)
Retrieves the paginated list of logs.
|
int |
getNumberOfLogs()
Returns the total number of logs.
|
SearchResult<Log> |
searchLogs(SearchOptions searchOptions)
Searches logs according to the criteria containing in the options.
|
Log getLog(long logId) throws LogNotFoundException
logId
- the identifier of the logLogNotFoundException
- If the log identifier does not refer to an existing logRetrieveException
- If an exception occurs during the role retrievingInvalidSessionException
- If the session is invalid (expired, unknown, ...)int getNumberOfLogs()
RetrieveException
- If an exception occurs during the count retrievingInvalidSessionException
- If the session is invalid (expired, unknown, ...)List<Log> getLogs(int startIndex, int maxResults, LogCriterion criterion)
startIndex
- the start indexmaxResults
- the max number of logscriterion
- the sorting criterionRetrieveException
- If an exception occurs during the log retrievingInvalidSessionException
- If the session is invalid (expired, unknown, ...)SearchResult<Log> searchLogs(SearchOptions searchOptions) throws SearchException
searchOptions
- the search criteriaSearchException
- If an exception occurs during the log searchingInvalidSessionException
- If the session is invalid (expired, unknown, ...)Copyright © 2014 Bonitasoft S.A.. All rights reserved.