Index (sakai-announcement-api 22.5 API)

A C E G H I M O R S V
All Classes All Packages

A

accept(Object) - Method in class org.sakaiproject.announcement.api.ViewableFilter: Does this object satisfy the criteria of the filter?
addAnnouncementChannel(String) - Method in interface org.sakaiproject.announcement.api.AnnouncementService: A (AnnouncementChannel) cover for addChannel() to add a new announcement channel.
addAnnouncementChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

A (AnnouncementChannel) cover for addChannel() to add a new announcement channel.
addAnnouncementMessage() - Method in interface org.sakaiproject.announcement.api.AnnouncementChannel: a (AnnouncementMessage) cover for addMessage to add a new message to this channel.
addAnnouncementMessage(String, boolean, List, String) - Method in interface org.sakaiproject.announcement.api.AnnouncementChannel: a (AnnouncementMessage) cover for addMessage to add a new message to this channel.
addChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Add a new channel.
allowAddChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

check permissions for addChannel().
allowEditChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

check permissions for editChannel()
allowGetChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

check permissions for getChannel().
allowRemoveChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Check permissions for removeChannel().
ANNOUNCEMENT_CHANNEL_PROPERTY - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: The property name of the channel to use instead of the site channel
AnnouncementChannel<T extends AnnouncementMessage> - Interface in org.sakaiproject.announcement.api: AnnouncementChannel is the extension to the MessageChanel interface for a Sakai Announcement service announcement channel.
AnnouncementChannelEdit - Interface in org.sakaiproject.announcement.api: AnnouncementChannelEdit is an editable AnnouncementChannel.
AnnouncementMessage - Interface in org.sakaiproject.announcement.api: AnnouncementMessage is the Interface for a Sakai Announcement message.
AnnouncementMessageEdit - Interface in org.sakaiproject.announcement.api: AnnouncementMessageEdit is an editable AnnouncementMessage.
AnnouncementMessageHeader - Interface in org.sakaiproject.announcement.api: AnnouncementMessageHeader is the Interface for a Sakai Announcement Message header.
AnnouncementMessageHeaderEdit - Interface in org.sakaiproject.announcement.api: AnnouncementMessageHeader is the Interface for a Sakai Announcement Message header.
AnnouncementsBullhornHandler - Class in org.sakaiproject.announcement.api
AnnouncementsBullhornHandler() - Constructor for class org.sakaiproject.announcement.api.AnnouncementsBullhornHandler
AnnouncementService - Class in org.sakaiproject.announcement.cover: Deprecated.
AnnouncementService - Interface in org.sakaiproject.announcement.api: AnnouncementService is the extension to MessageService configured for Announcements.
AnnouncementService() - Constructor for class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
APPLICATION_ID - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: The type string for this application: should not change over time as it may be stored in various parts of persistent entities.
APPLICATION_ID - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
archive(String, Document, Stack, String, List) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
ASSIGNMENT_REFERENCE - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: assignment reference property for announcements
ASSIGNMENT_REFERENCE - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

C

cancelChannel(MessageChannelEdit) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Cancel the changes made to a MessageChannelEdit object, and release the lock.
cancelMessage(MessageEdit) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Cancel the changes made to a MessageEdit object, and release the lock.
channelReference(String, String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Access the internal reference which can be used to access the channel from within the system.
clearMessagesCache(String) - Method in interface org.sakaiproject.announcement.api.AnnouncementService: clears the message cache for this channel
clearMessagesCache(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

clears the message cache for this channel
commitChannel(MessageChannelEdit) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Commit the changes made to a MessageChannelEdit object, and release the lock.

E

editAnnouncementMessage(String) - Method in interface org.sakaiproject.announcement.api.AnnouncementChannel: A (AnnouncementMessageEdit) cover for editMessage.
editChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Return a specific channel, as specified by channel id, locked for update.
EVENT_ANNC_UPDATE_ACCESS - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: Event for updating announcement access
EVENT_ANNC_UPDATE_ACCESS - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
EVENT_ANNC_UPDATE_AVAILABILITY - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: Event for updating announcement availability
EVENT_ANNC_UPDATE_AVAILABILITY - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
EVENT_ANNC_UPDATE_TITLE - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: Event for updating announcement title
EVENT_ANNC_UPDATE_TITLE - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Events
EVENT_AVAILABLE_ANNC - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: Event for delayed announcement
EVENT_AVAILABLE_ANNC - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

G

getAnnouncementChannel(String) - Method in interface org.sakaiproject.announcement.api.AnnouncementService: A (AnnouncementChannel) cover for getChannel() to return a specific announcement channel.
getAnnouncementChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

A (AnnouncementChannel) cover for getChannel() to return a specific announcement channel.
getAnnouncementHeader() - Method in interface org.sakaiproject.announcement.api.AnnouncementMessage: A (AnnouncementMessageHeader) cover for getHeader to access the announcement message header.
getAnnouncementHeaderEdit() - Method in interface org.sakaiproject.announcement.api.AnnouncementMessageEdit: A (AnnouncementMessageHeaderEdit) cover for getHeaderEdit to access the announcement message header.
getAnnouncementMessage(String) - Method in interface org.sakaiproject.announcement.api.AnnouncementChannel: A (AnnouncementMessage) cover for getMessage to return a specific announcement channel message, as specified by message id.
getAnnouncementReference(String) - Method in interface org.sakaiproject.announcement.api.AnnouncementService: Get announcement entity reference for given context
getAnnouncementReference(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Get announcement entity reference for given context
getChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Return a specific channel.
getChannelIds(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Access a list of channel ids that are defined related to the context.
getChannels() - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Return a list of all the defined channels.
getHandledEvents() - Method in class org.sakaiproject.announcement.api.AnnouncementsBullhornHandler
getInstance() - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Access the component instance: special cover only method.
getLabel() - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
getMessage(Reference) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Get a message, given a reference.
getMessages(String, Filter, boolean, boolean) - Method in interface org.sakaiproject.announcement.api.AnnouncementService: Return a list of messages from the provided channel (merged flag returns merged messages)
getMessages(String, Filter, boolean, boolean) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Return a list of messages from the provided channel (merged flag returns merged messages)
getMessages(String, Time, int, boolean, boolean, boolean) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Access a list of messages in the channel, that are after the date, limited to just the n latest messages, ordered as specified, including drafts if specified.
getRssUrl(Reference) - Method in interface org.sakaiproject.announcement.api.AnnouncementService: Get URL to access the announcement rss feed
getRssUrl(Reference) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Get URL to access the announcement rss feed
getSubject() - Method in interface org.sakaiproject.announcement.api.AnnouncementMessageHeader: Access the subject of the announcement.
getSummary(String, int, int) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Get a summary of an Announcement Channel
getViewableAnnouncementsForCurrentUser(Integer) - Method in interface org.sakaiproject.announcement.api.AnnouncementService
getViewableAnnouncementsForSite(String, Integer) - Method in interface org.sakaiproject.announcement.api.AnnouncementService

H

handleEvent(Event) - Method in class org.sakaiproject.announcement.api.AnnouncementsBullhornHandler

I

isMessageViewable(AnnouncementMessage) - Method in interface org.sakaiproject.announcement.api.AnnouncementService: Determine if message viewable based on release/retract dates (if set)
isMessageViewable(AnnouncementMessage) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Determine if message viewable based on release/retract dates (if set)

M

merge(String, Element, String, String, Map, HashMap, Set) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
messageReference(String, String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Access the internal reference which can be used to access the message from within the system.
messageReference(String, String, String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Access the internal reference which can be used to access the message from within the system.
MOD_DATE - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: modified date property names for announcements
MOD_DATE - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
MOTD_TOOL_ID - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService

O

org.sakaiproject.announcement.api - package org.sakaiproject.announcement.api
org.sakaiproject.announcement.cover - package org.sakaiproject.announcement.cover

R

REF_TYPE_ANNOUNCEMENT - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: The Reference type for an announcement
REF_TYPE_ANNOUNCEMENT_RSS - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: The Reference type for an announcement rss feed
REF_TYPE_CHANNEL - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
REF_TYPE_MESSAGE - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
REFERENCE_ROOT - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: This string starts the references to resources in this service.
REFERENCE_ROOT - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
RELEASE_DATE - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: release date property names for announcements
RELEASE_DATE - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
removeAnnouncementMessage(String) - Method in interface org.sakaiproject.announcement.api.AnnouncementChannel: A cover for removeMessage.
removeChannel(MessageChannelEdit) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

Remove a channel - it must be locked from editChannel().
RETRACT_DATE - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: retract date property names for announcements
RETRACT_DATE - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.

S

SECURE_ADD - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_ANNC_ADD - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: Security lock / event for adding channel / message.
SECURE_ANNC_ADD - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_ANNC_ALL_GROUPS - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: Security function giving the user permission to all groups, if granted to at the channel or site level.
SECURE_ANNC_READ - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: Security lock / event for reading channel / message.
SECURE_ANNC_READ - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_ANNC_READ_DRAFT - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: Security lock / event for accessing someone elses draft.
SECURE_ANNC_READ_DRAFT - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_ANNC_REMOVE_ANY - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: Security lock / event for removing anyone's message or channel.
SECURE_ANNC_REMOVE_ANY - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_ANNC_REMOVE_OWN - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: Security lock / event for removing one's own message.
SECURE_ANNC_REMOVE_OWN - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_ANNC_ROOT - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: Security lock / event root for generic message events to make it a mail event.
SECURE_ANNC_ROOT - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_ANNC_UPDATE_ANY - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: Security lock / event for updating any message.
SECURE_ANNC_UPDATE_ANY - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_ANNC_UPDATE_OWN - Static variable in interface org.sakaiproject.announcement.api.AnnouncementService: Security lock / event for updating one's own message or the channel.
SECURE_ANNC_UPDATE_OWN - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_READ - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_READ_DRAFT - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_REMOVE_ANY - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_REMOVE_OWN - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_UPDATE_ANY - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
SECURE_UPDATE_OWN - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService: Deprecated.
setSubject(String) - Method in interface org.sakaiproject.announcement.api.AnnouncementMessageHeaderEdit: Set the subject of the announcement.

V

ViewableFilter - Class in org.sakaiproject.announcement.api: Allows some basic functions on announcements.
ViewableFilter(Filter, Time, int, AnnouncementService) - Constructor for class org.sakaiproject.announcement.api.ViewableFilter: Show viewable announcements and limit the result

A C E G H I M O R S V
All Classes All Packages