| org.sakaiproject.event.api.EventTrackingService
All known Subclasses: org.sakaiproject.event.impl.BaseEventTrackingService,
| EventTrackingService | | public interface EventTrackingService (Code) | |
The event tracking service provides activity event tracking and monitoring.
Objects act as event generators, posting events to the service.
Other objects act as event monitors, and are notified by the service when certain events occur.
Events posted are also stored in event archives by the service.
|
| Field Summary | |
| final static String | SERVICE_NAME
This string can be used to find the service in the service manager. |
| Method Summary | |
| void | addLocalObserver(Observer observer)
Add an observer of events. | | void | addObserver(Observer observer)
Add an observer of events. | | void | addPriorityObserver(Observer observer)
Add an observer of events. | | void | deleteObserver(Observer observer)
Delete an observer of events. | | Event | newEvent(String event, String resource, boolean modify)
Construct a Event object.
Parameters:
event - The Event id.
Parameters:
resource - The resource reference.
Parameters:
modify - Set to true if this event caused a resource modification, false if it was just an access. | | Event | newEvent(String event, String resource, boolean modify, int priority)
Construct a Event object.
Parameters:
event - The Event id.
Parameters:
resource - The resource reference.
Parameters:
modify - Set to true if this event caused a resource modification, false if it was just an access.
Parameters:
priority - The Event's notification priority. | | void | post(Event event)
Post an event
Parameters:
event - The event object (created with newEvent()). | | void | post(Event event, UsageSession session)
|
| SERVICE_NAME | | final static String SERVICE_NAME(Code) | | This string can be used to find the service in the service manager.
|
| addLocalObserver | | void addLocalObserver(Observer observer)(Code) | | Add an observer of events. The observer will be notified whenever there are new events. Local observers get notified only of event generated on this application server, not on those generated elsewhere.
Parameters:
observer - The class observing. |
| addObserver | | void addObserver(Observer observer)(Code) | | Add an observer of events. The observer will be notified whenever there are new events.
Parameters:
observer - The class observing. |
| addPriorityObserver | | void addPriorityObserver(Observer observer)(Code) | | Add an observer of events. The observer will be notified whenever there are new events. Priority observers get notified first, before normal observers.
Parameters:
observer - The class observing. |
| deleteObserver | | void deleteObserver(Observer observer)(Code) | | Delete an observer of events.
Parameters:
observer - The class observing to delete. |
| newEvent | | Event newEvent(String event, String resource, boolean modify)(Code) | | Construct a Event object.
Parameters:
event - The Event id.
Parameters:
resource - The resource reference.
Parameters:
modify - Set to true if this event caused a resource modification, false if it was just an access. A new Event object that can be used with this service. |
| newEvent | | Event newEvent(String event, String resource, boolean modify, int priority)(Code) | | Construct a Event object.
Parameters:
event - The Event id.
Parameters:
resource - The resource reference.
Parameters:
modify - Set to true if this event caused a resource modification, false if it was just an access.
Parameters:
priority - The Event's notification priority. A new Event object that can be used with this service. |
| post | | void post(Event event)(Code) | | Post an event
Parameters:
event - The event object (created with newEvent()). Note: the current session user will be used as the user responsible for the event. |
| post | | void post(Event event, UsageSession session)(Code) | | Post an event on behalf of a user's session
Parameters:
event - The event object (created with newEvent()).
Parameters:
session - The usage session object of the user session responsible for the event. |
|
|