01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/event/tags/sakai_2-4-1/event-api/api/src/java/org/sakaiproject/event/api/NotificationEdit.java $
03: * $Id: NotificationEdit.java 7072 2006-03-27 20:55:20Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 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: import org.sakaiproject.entity.api.Edit;
23:
24: /**
25: * <p>
26: * NotificationEdit is a mutable Notification.
27: * </p>
28: */
29: public interface NotificationEdit extends Notification, Edit {
30: /**
31: * Do the notification.
32: *
33: * @param event
34: * The event that matched criteria to cause the notification.
35: */
36: void notify(Event event);
37:
38: /**
39: * Set the Event function, clearing any that have already been set.
40: *
41: * @param event
42: * The Event function to watch for.
43: */
44: void setFunction(String function);
45:
46: /**
47: * Add another Event function.
48: *
49: * @param event
50: * Another Event function to watch for.
51: */
52: void addFunction(String function);
53:
54: /**
55: * Set the resource reference filter.
56: *
57: * @param filter
58: * The resource reference filter.
59: */
60: void setResourceFilter(String filter);
61:
62: /**
63: * Set the action helper that handles the notify() action.
64: *
65: * @param action
66: * The action helper that handles the notify() action.
67: */
68: void setAction(NotificationAction action);
69: }
|