org.bonitasoft.engine.services

Interface QueriableLoggerService

All Known Implementing Classes:

QueriableLoggerImpl

public interface QueriableLoggerService

Author:

Charles Souillard, Celine Souchet

Method Summary

Modifier and Type	Method and Description
SQueriableLog	getLog(long logId) Get the queriable log from its id.
java.util.List<SQueriableLog>	getLogs(int startIndex, int maxResults, java.lang.String field, OrderByType order) Get the queriable logs having the given value for the given int index
long	getNumberOfLogs() Get total number of queriable logs
long	getNumberOfLogs(QueryOptions searchOptions) Gets the queriable logs number matching to the given QueryOptions.
boolean	isLoggable(java.lang.String actionType, SQueriableLogSeverity severity) Verify if the given action type and severity are loggable
void	log(java.lang.String callerClassName, java.lang.String callerMethodName, SQueriableLog... queriableLogs) Log the given queriable logs.
java.util.List<SQueriableLog>	searchLogs(QueryOptions searchOptions) Gets the queriable logs matching to the given searchOptions.

Method Detail

log

void log(java.lang.String callerClassName,
         java.lang.String callerMethodName,
         SQueriableLog... queriableLogs)

Log the given queriable logs. Only logs having the action type and the severity configured to as loggable will be logged

Parameters:

queriableLogs -

Since:

6.0

isLoggable

boolean isLoggable(java.lang.String actionType,
                   SQueriableLogSeverity severity)

Verify if the given action type and severity are loggable

Parameters:

actionType - the action type

severity - the severity

Returns:

true if the log is active for the given action type and severity; false otherwise

Since:

6.0

getLog

SQueriableLog getLog(long logId)
              throws SQueriableLogNotFoundException,
                     SBonitaReadException

Get the queriable log from its id.

Parameters:

logId -

Returns:

the queriable log

Throws:

SQueriableLogException

SQueriableLogNotFoundException

SBonitaReadException

Since:

6.0

getNumberOfLogs

long getNumberOfLogs()
              throws SBonitaReadException

Get total number of queriable logs

Returns:

the number of queriable logs

Throws:

SBonitaReadException

Since:

6.0

getLogs

java.util.List<SQueriableLog> getLogs(int startIndex,
                                      int maxResults,
                                      java.lang.String field,
                                      OrderByType order)
                               throws SBonitaReadException

Get the queriable logs having the given value for the given int index

Parameters:

fromIndex - first result to be considered(>=0)

numberOfLogs - the max number of queriable logs to be returned (>=0)

field -

order -

Returns:

the queriable logs having the given value for the given int index

Throws:

SQueriableLogException

SBonitaReadException

Since:

6.0

getNumberOfLogs

long getNumberOfLogs(QueryOptions searchOptions)
              throws SBonitaReadException

Gets the queriable logs number matching to the given QueryOptions.

Parameters:

QueryOptions - The criterion used to search sQueriableLog

Returns:

queriable logs number matching to the given searchOptions.

Throws:

SBonitaReadException

Since:

6.0

searchLogs

java.util.List<SQueriableLog> searchLogs(QueryOptions searchOptions)
                                  throws SBonitaReadException

Gets the queriable logs matching to the given searchOptions.

Parameters:

searchOptions - The criterion used to search sQueriableLog

Returns:

logs list matching to the given searchOptions.

Throws:

SBonitaReadException

Since:

6.0