org.sakaiproject.service.legacy.chat
Interface ChatService

All Superinterfaces:
EntityProducer, MessageService
All Known Implementing Classes:
BaseChatService

public interface ChatService
extends MessageService

ChatService is the extension to GenericMessageService configured for Chat.

MessageChannels are ChatMessageChannels, and Messages are ChatMessages with ChatMessageHeaders.

Security is defined, see MessageService.

Usage Events are generated:

Version:
$Revision: 2371 $
Author:
University of Michigan, CHEF Software Development Team
See Also:
org.chefproject.core.ChatChannel, org.chefproject.core.ChatMessage

Nested Class Summary
 
Nested classes inherited from class org.sakaiproject.service.legacy.entity.EntityProducer
EntityProducer.ChangeType
 
Field Summary
static String REFERENCE_ROOT
          This string starts the references to resources in this service.
static String SERVICE_NAME
          This string can be used to find the service in the service manager.
 
Fields inherited from interface org.sakaiproject.service.legacy.message.MessageService
REF_TYPE_CHANNEL, REF_TYPE_CHANNEL_GROUPS, REF_TYPE_MESSAGE, SECURE_ADD, SECURE_ALL_GROUPS, SECURE_READ, SECURE_READ_DRAFT, SECURE_REMOVE_ANY, SECURE_REMOVE_OWN, SECURE_UPDATE_ANY, SECURE_UPDATE_OWN
 
Method Summary
 ChatChannelEdit addChatChannel(String ref)
          A (ChatChannel) cover for addChannel() to add a new chat channel.
 ChatChannel getChatChannel(String ref)
          A (ChatChannel) cover for getChannel() to return a specific chat channel.
 
Methods inherited from interface org.sakaiproject.service.legacy.message.MessageService
addChannel, allowAddChannel, allowEditChannel, allowGetChannel, allowRemoveChannel, cancelChannel, cancelMessage, channelReference, commitChannel, editChannel, getChannel, getChannelIds, getChannels, getMessage, getMessages, messageReference, messageReference, removeChannel
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.EntityProducer
archive, getEntity, getEntityAuthzGroups, getEntityDescription, getEntityResourceProperties, getEntityUrl, getHttpAccess, getLabel, importEntities, merge, parseEntityReference, syncWithSiteChange, willArchiveMerge, willImport
 

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME
This string can be used to find the service in the service manager.


REFERENCE_ROOT

public static final String REFERENCE_ROOT
This string starts the references to resources in this service.

See Also:
Constant Field Values
Method Detail

getChatChannel

public ChatChannel getChatChannel(String ref)
                           throws IdUnusedException,
                                  PermissionException
A (ChatChannel) cover for getChannel() to return a specific chat channel.

Parameters:
ref - The channel reference.
Returns:
the ChatChannel that has the specified name.
Throws:
IdUnusedException - If this name is not defined for a chat channel.
PermissionException - If the user does not have any permissions to the channel.

addChatChannel

public ChatChannelEdit addChatChannel(String ref)
                               throws IdUsedException,
                                      IdInvalidException,
                                      PermissionException
A (ChatChannel) cover for addChannel() to add a new chat channel.

Parameters:
ref - The channel reference.
Returns:
The newly created channel.
Throws:
IdUsedException - if the id is not unique.
IdInvalidException - if the id is not made up of valid characters.
PermissionException - if the user does not have permission to add a channel.