Statisticable (Sakai Entity Broker API 22.3 API)

All Superinterfaces:

EntityProvider
```
public interface Statisticable
extends EntityProvider
```
This capability is for tracking statistics of events for entities related to a tool, it will be used by the site stats service for event tracking and reporting
Contact Nuno Fernandes (nuno@ufp.edu.pt) if you have questions
This is one of the capability extensions for the EntityProvider interface

Author:

Nuno Fernandes (nuno@ufp.edu.pt), Aaron Zeckoski (aaron@caret.cam.ac.uk)

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default String`	`getAssociatedToolId()`	Return the associated common tool.id for this tool
`default String[]`	`getEventKeys()`	Return an array of all the event keys which should be tracked for statistics
`default Map<String,String>`	`getEventNames(Locale locale)`	OPTIONAL: return null if you do not want to implement this Return the event key => event name map for a given Locale, allows the author to create human readable i18n names for their event keys

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.EntityProvider
getEntityPrefix

- Method Detail
  - getAssociatedToolId
```
default String getAssociatedToolId()
```
    Return the associated common tool.id for this tool
    
    Returns:
    
    the tool id (example: "sakai.messages")
  - getEventKeys
```
default String[] getEventKeys()
```
    Return an array of all the event keys which should be tracked for statistics
    
    Returns:
    
    an array if event keys (example: "message.new" , "message.delete")
  - getEventNames
```
default Map<String,String> getEventNames(Locale locale)
```
    OPTIONAL: return null if you do not want to implement this
    Return the event key => event name map for a given Locale, allows the author to create human readable i18n names for their event keys
    
    Parameters:
    
    locale - the locale to return the names for
    
    Returns:
    
    the map of event key => event name (example: for a 'en' locale: {"message.new","A new message"}) OR null to use the event keys