01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/chat/tags/sakai_2-4-1/chat-api/api/src/java/org/sakaiproject/chat/api/ChatService.java $
03: * $Id: ChatService.java 21005 2007-02-05 02:40:13Z csev@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.chat.api;
21:
22: import org.sakaiproject.exception.IdInvalidException;
23: import org.sakaiproject.exception.IdUnusedException;
24: import org.sakaiproject.exception.IdUsedException;
25: import org.sakaiproject.exception.PermissionException;
26: import org.sakaiproject.message.api.MessageService;
27:
28: /**
29: * <p>
30: * ChatService is the extension to MessageService configured for Chat.
31: * </p>
32: * <p>
33: * MessageChannels are ChatMessageChannels, and Messages are ChatMessages with ChatMessageHeaders.
34: * </p>
35: * <p>
36: * Security is defined, see MessageService.
37: * </p>
38: * <p>
39: * Usage Events are generated:
40: * <ul>
41: * <li>chat.message.channel.add - chat channel resource id</li>
42: * <li>chat.message.channel.remove - chat channel resource id</li>
43: * </ul>
44: * </p>
45: */
46: public interface ChatService extends MessageService {
47: /** The type string for this application: should not change over time as it may be stored in various parts of persistent entities. */
48: static final String APPLICATION_ID = "sakai:chat";
49:
50: /** This string starts the references to resources in this service. */
51: public static final String REFERENCE_ROOT = "/chat";
52:
53: /**
54: * A (ChatChannel) cover for getChannel() to return a specific chat channel.
55: *
56: * @param ref
57: * The channel reference.
58: * @return the ChatChannel that has the specified name.
59: * @exception IdUnusedException
60: * If this name is not defined for a chat channel.
61: * @exception PermissionException
62: * If the user does not have any permissions to the channel.
63: */
64: public ChatChannel getChatChannel(String ref)
65: throws IdUnusedException, PermissionException;
66:
67: /**
68: * A (ChatChannel) cover for addChannel() to add a new chat channel.
69: *
70: * @param ref
71: * The channel reference.
72: * @return The newly created channel.
73: * @exception IdUsedException
74: * if the id is not unique.
75: * @exception IdInvalidException
76: * if the id is not made up of valid characters.
77: * @exception PermissionException
78: * if the user does not have permission to add a channel.
79: */
80: public ChatChannelEdit addChatChannel(String ref)
81: throws IdUsedException, IdInvalidException,
82: PermissionException;
83:
84: }
|