org.sakaiproject.service.legacy.announcement
Interface AnnouncementService

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

public interface AnnouncementService
extends MessageService

GenericAnnouncementService is the extension to GenericMessageService configured for Announcements.

MessageChannels are AnnouncementMessageChannels, and Messages are AnnouncementMessages with AnnouncementMessageHeaders.

Security in the announcement service, in addition to that defined in the channels, include:

  • announcement.channel.remove
  • Usage Events are generated:

    Version:
    $Revision: 2371 $
    Author:
    University of Michigan, Sakai Software Development Team
    See Also:
    org.sakaiproject.core.AnnouncementChannel

    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 SECURE_ANNC_ADD
              Security lock / event for adding channel / message.
    static String SECURE_ANNC_READ
              Security lock / event for reading channel / message.
    static String SECURE_ANNC_READ_DRAFT
              Security lock / event for accessing someone elses draft.
    static String SECURE_ANNC_REMOVE_ANY
              Security lock / event for removing anyone's message or channel.
    static String SECURE_ANNC_REMOVE_OWN
              Security lock / event for removing one's own message.
    static String SECURE_ANNC_ROOT
              Security lock / event root for generic message events to make it a mail event.
    static String SECURE_ANNC_UPDATE_ANY
              Security lock / event for updating any message.
    static String SECURE_ANNC_UPDATE_OWN
              Security lock / event for updating one's own message or the channel.
    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
     AnnouncementChannelEdit addAnnouncementChannel(String ref)
              A (AnnouncementChannel) cover for addChannel() to add a new announcement channel.
     AnnouncementChannel getAnnouncementChannel(String ref)
              A (AnnouncementChannel) cover for getChannel() to return a specific announcement 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

    SECURE_ANNC_ROOT

    public static final String SECURE_ANNC_ROOT
    Security lock / event root for generic message events to make it a mail event.

    See Also:
    Constant Field Values

    SECURE_ANNC_READ

    public static final String SECURE_ANNC_READ
    Security lock / event for reading channel / message.

    See Also:
    Constant Field Values

    SECURE_ANNC_ADD

    public static final String SECURE_ANNC_ADD
    Security lock / event for adding channel / message.

    See Also:
    Constant Field Values

    SECURE_ANNC_REMOVE_OWN

    public static final String SECURE_ANNC_REMOVE_OWN
    Security lock / event for removing one's own message.

    See Also:
    Constant Field Values

    SECURE_ANNC_REMOVE_ANY

    public static final String SECURE_ANNC_REMOVE_ANY
    Security lock / event for removing anyone's message or channel.

    See Also:
    Constant Field Values

    SECURE_ANNC_UPDATE_OWN

    public static final String SECURE_ANNC_UPDATE_OWN
    Security lock / event for updating one's own message or the channel.

    See Also:
    Constant Field Values

    SECURE_ANNC_UPDATE_ANY

    public static final String SECURE_ANNC_UPDATE_ANY
    Security lock / event for updating any message.

    See Also:
    Constant Field Values

    SECURE_ANNC_READ_DRAFT

    public static final String SECURE_ANNC_READ_DRAFT
    Security lock / event for accessing someone elses draft.

    See Also:
    Constant Field Values
    Method Detail

    getAnnouncementChannel

    public AnnouncementChannel getAnnouncementChannel(String ref)
                                               throws IdUnusedException,
                                                      PermissionException
    A (AnnouncementChannel) cover for getChannel() to return a specific announcement channel.

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

    addAnnouncementChannel

    public AnnouncementChannelEdit addAnnouncementChannel(String ref)
                                                   throws IdUsedException,
                                                          IdInvalidException,
                                                          PermissionException
    A (AnnouncementChannel) cover for addChannel() to add a new announcement 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.