org.alfresco.bm.event

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, Frederik Heremans

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ResultService.EventSummary Summary of event times and failures for a given event name
static interface	ResultService.ResultHandler Callback handler for aggregated results

Method Summary

Methods

Modifier and Type	Method and Description
long	countEventsByFailure()
long	countEventsByName(String name) Count the number of previously-completed events with the given name.
long	countEventsBySuccess()
String	getDataLocation() Get details on the location of the results that the service is accessing
List<String>	getEventNames() Get a discrete list of event names from across all the results
long	getMaxStartTime()
long	getMinStartTime()
TreeMap<String,ResultService.EventSummary>	getResults(boolean chartOnly) Build results for all events and give them back as an event summary instance.
List<EventRecord>	getResults(boolean successOrFail, int skip, int limit) Retrieve a page of event results matching the success property.
List<EventRecord>	getResults(long startTime, String eventName, Boolean successOrFail, int skip, int limit) Retrieve a page of event results using a time window
void	getResults(ResultService.ResultHandler handler, long startTime, String eventName, Boolean successOrFail, long windowSize, 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
List<EventRecord>	getResultsForSession(String eventSessionId, int skip, int limit) Retrieve a page of event results by event session ID
EventRecord	recordResult(EventRecord result) Simply store an event for later use

Method Detail

getDataLocation

String getDataLocation()

Get details on the location of the results that the service is accessing

Returns:

a string description of the data location

recordResult

EventRecord recordResult(EventRecord result)

Simply store an event for later use

Parameters:

result - the result to store

Returns:

Returns the result as persisted

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

getResultsForSession

List<EventRecord> getResultsForSession(String eventSessionId,
                                     int skip,
                                     int limit)

Retrieve a page of event results by event session ID

Parameters:

eventSessionId - the event session ID

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

limit - the number of results to retrieve

Returns:

Returns any recorded results for the given session

getResults

List<EventRecord> getResults(long startTime,
                           String eventName,
                           Boolean successOrFail,
                           int skip,
                           int limit)

Retrieve a page of event results using a time window

Parameters:

startTime - the first event time (inclusive, milliseconds)

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

successOrFail - true for success only or false for failures (null for all)

getResults

List<EventRecord> getResults(boolean successOrFail,
                           int skip,
                           int limit)

Retrieve a page of event results matching the success property.

Parameters:

successOrFail -

skip -

limit -

Returns:

getResults

TreeMap<String,ResultService.EventSummary> getResults(boolean chartOnly)

Build results for all events and give them back as an event summary instance.

Parameters:

chartOnly - true to only summarize chartable results

Returns:

summary of all events ordered by event name

getResults

void getResults(ResultService.ResultHandler handler,
              long startTime,
              String eventName,
              Boolean successOrFail,
              long windowSize,
              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

successOrFail - true for success only or false for failures (null for all)

windowSize - the length (milliseconds) of a time window

chartOnly - true if only chartable results must be retrieved

getEventNames

List<String> getEventNames()

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

countEventsByName

long countEventsByName(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

countEventsBySuccess

long countEventsBySuccess()

Returns:

the number of successfully completed events

countEventsByFailure

long countEventsByFailure()

Returns:

the number of failed events

getMinStartTime

long getMinStartTime()

Returns:

the time of the first result

getMaxStartTime

long getMaxStartTime()

Returns:

the time of the latest result