01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/rwiki/tags/sakai_2-4-1/rwiki-api/api/src/java/uk/ac/cam/caret/sakai/rwiki/service/message/api/MessageService.java $
03: * $Id: MessageService.java 9108 2006-05-08 14:30:57Z ian@caret.cam.ac.uk $
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 uk.ac.cam.caret.sakai.rwiki.service.message.api;
21:
22: import java.util.List;
23:
24: /**
25: * @author ieb
26: */
27: public interface MessageService {
28:
29: /**
30: * Updates the session presence record in the wiki
31: *
32: * @param session
33: * @param user
34: * @param page
35: * @param space
36: */
37: void updatePresence(String session, String user, String page,
38: String space);
39:
40: void addMessage(String session, String user, String page,
41: String space, String message);
42:
43: /**
44: * returns a List of the Messages associated with the session
45: *
46: * @param session
47: * @return
48: */
49: List getSessionMessages(String session);
50:
51: /**
52: * Returns List of the Messages in the space
53: *
54: * @param space
55: * @return
56: */
57: List getMessagesInSpace(String space);
58:
59: /**
60: * Returns List of Messages in the page
61: *
62: * @param space
63: * @param page
64: * @return
65: */
66: List getMessagesInPage(String space, String page);
67:
68: /**
69: * Returns List representation of the users in the space
70: *
71: * @param space
72: * @return
73: */
74: List getUsersInSpace(String space);
75:
76: /**
77: * Returns List representation of the users on the page
78: *
79: * @param space
80: * @param page
81: * @return
82: */
83: List getUsersOnPage(String space, String page);
84:
85: /**
86: * @param pageSpace
87: * @param pageName
88: * @return
89: */
90: List getUsersInSpaceOnly(String pageSpace, String pageName);
91:
92: }
|