org.sakaiproject.service.legacy.event
Interface Event

All Known Implementing Classes:
BaseEventTrackingService.BaseEvent, EventImpl

public interface Event

Event is the core interface for the CHEF Event object.

Event objects are posted to the EventTracking service, and may be listened for.

Version:
$Revision:
Author:
University of Michigan, CHEF Software Development Team

Method Summary
 String getEvent()
          Access the event id string
 boolean getModify()
          Is this event one that caused a modify to the resource, or just an access.
 int getPriority()
          Access the event's notification priority.
 String getResource()
          Access the resource reference.
 String getSessionId()
          Access the UsageSession id.
 String getUserId()
          Access the User id.
 

Method Detail

getEvent

public String getEvent()
Access the event id string

Returns:
The event id string.

getResource

public String getResource()
Access the resource reference.

Returns:
The resource reference string.

getSessionId

public String getSessionId()
Access the UsageSession id. If null, check for a User id.

Returns:
The UsageSession id string.

getUserId

public String getUserId()
Access the User id. If null, check for a session id.

Returns:
The User id string.

getModify

public boolean getModify()
Is this event one that caused a modify to the resource, or just an access.

Returns:
true if the event caused a modify to the resource, false if it was just an access.

getPriority

public int getPriority()
Access the event's notification priority.

Returns:
The event's notification priority.