01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/event/tags/sakai_2-4-1/event-api/api/src/java/org/sakaiproject/event/api/Event.java $
03: * $Id: Event.java 7036 2006-03-27 00:31:07Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.event.api;
21:
22: /**
23: * <p>
24: * Event represents a single significant activity by the end-user.
25: * </p>
26: */
27: public interface Event {
28: /**
29: * Access the event id string
30: *
31: * @return The event id string.
32: */
33: String getEvent();
34:
35: /**
36: * Access the resource reference.
37: *
38: * @return The resource reference string.
39: */
40: String getResource();
41:
42: /**
43: * Access the UsageSession id. If null, check for a User id.
44: *
45: * @return The UsageSession id string.
46: */
47: String getSessionId();
48:
49: /**
50: * Access the User id. If null, check for a session id.
51: *
52: * @return The User id string.
53: */
54: String getUserId();
55:
56: /**
57: * Is this event one that caused a modify to the resource, or just an access.
58: *
59: * @return true if the event caused a modify to the resource, false if it was just an access.
60: */
61: boolean getModify();
62:
63: /**
64: * Access the event's notification priority.
65: *
66: * @return The event's notification priority.
67: */
68: int getPriority();
69: }
|