org.alfresco.bm.common

Interface ResultService

All Known Implementing Classes:

AbstractResultService, MongoResultService

public interface ResultService

Service interface providing methods to store and query for event results.

Since:

1.0

Author:

Derek Hulley

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ResultService.ResultHandler Callback handler for aggregated results.

Method Summary

Modifier and Type	Method and Description
boolean	clear() Clears all recorded data
long	countResults() Count the number of events
long	countResultsByEventName(String name) Count the number of previously-completed events with the given name.
long	countResultsByFailure()
long	countResultsBySuccess()
String	getDataLocation()
List<EventDetails>	getEventDetails(EventResultFilter filter, String filterEventName, int skip, int limit) Query and returns event result details as requested.
List<String>	getEventNames() Get a discrete list of event names from across all the results
EventRecord	getFirstResult() Retrieve the first result by start time
EventRecord	getLastResult() Retrieve the last result by start time
List<EventRecord>	getResults(long startTime, long endTime, boolean chartOnly, int skip, int limit) Retrieve a page of event results using a time window, filtering by chartability
void	getResults(ResultService.ResultHandler handler, long startTime, long windowSize, long reportPeriod, boolean chartOnly) Get result statistics for discrete time intervals.
List<EventRecord>	getResults(String eventName, int skip, int limit) Retrieve a page of event results by event name
void	recordResult(EventRecord result) Simply store an event for later use

Method Detail

getDataLocation

String getDataLocation()

Returns:

a string giving the location of the raw data

recordResult

void recordResult(EventRecord result)

Simply store an event for later use

Parameters:

result - the result to store

getFirstResult

EventRecord getFirstResult()

Retrieve the first result by start time

Returns:

the first result or null if there are none

getLastResult

EventRecord getLastResult()

Retrieve the last result by start time

Returns:

the last result or null if there are none

getResults

List<EventRecord> getResults(String eventName,
                             int skip,
                             int limit)

Retrieve a page of event results by event name

Parameters:

eventName - the name of the event as recorded

skip - the number of results to skip (for paging)

limit - the number of results to retrieve

Returns:

Returns any recorded results with the given name

getResults

List<EventRecord> getResults(long startTime,
                             long endTime,
                             boolean chartOnly,
                             int skip,
                             int limit)

Retrieve a page of event results using a time window, filtering by chartability

Parameters:

startTime - the first event time (inclusive, milliseconds)

endTime - the last event time (exclusive, milliseconds)

chartOnly - true to only retrieve results for charting

getResults

void getResults(ResultService.ResultHandler handler,
                long startTime,
                long windowSize,
                long reportPeriod,
                boolean chartOnly)

Get result statistics for discrete time intervals.

A callback will be received for every time period requested.

Parameters:

handler - the client callback implementation

startTime - the start of the first results (inclusive, milliseconds). The first reporting window will be moved to the first event after this time and reset to a multiple of the windowSize.

eventName - the name of the event to use or null for all event names

windowSize - the length (milliseconds) of a time window. This must be a multiple of the 'reportPeriod'.

reportPeriod - the result time report period (milliseconds). This cannot be more than the 'windowSize'.

chartOnly - true if only chartable results must be retrieved

getEventDetails

List<EventDetails> getEventDetails(EventResultFilter filter,
                                   String filterEventName,
                                   int skip,
                                   int limit)

Query and returns event result details as requested.

Parameters:

filter - (EventResultFilter) filter by fail / success / none

filterEventName - (String, optional) if set only the results for the given event will be returned

skip - (int) useful for paging

limit - (int) max number of results to return

Returns:

List of event details

getEventNames

List<String> getEventNames()

Get a discrete list of event names from across all the results

countResults

long countResults()

Count the number of events

Returns:

the number of completed events

countResultsByEventName

long countResultsByEventName(String name)

Count the number of previously-completed events with the given name.

Parameters:

name - the name of the event as recored

Returns:

the count

countResultsBySuccess

long countResultsBySuccess()

Returns:

the number of successfully completed events

countResultsByFailure

long countResultsByFailure()

Returns:

the number of failed events

clear

boolean clear()

Clears all recorded data

Returns:

true if success, false else

Since:

2.1.4