A C E G I M O R S

A

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

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

Add a new channel.

allowAddChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

check permissions for addChannel().

allowEditChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

check permissions for editChannel()

allowGetChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

check permissions for getChannel().

allowRemoveChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

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.

AnnouncementService - Interface in org.sakaiproject.announcement.api

AnnouncementService is the extension to MessageService configured for Announcements.

AnnouncementService - Class in org.sakaiproject.announcement.cover

AnnouncementService is a static Cover for the AnnouncementService; see that interface for usage details.

AnnouncementService() - Constructor for class org.sakaiproject.announcement.cover.AnnouncementService

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

archive(String, Document, Stack, String, List) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

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

C

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

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

cancelMessage(MessageEdit) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

Cancel the changes made to a MessageEdit object, and release the lock.

channelReference(String, String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

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

clears the message cache for this channel

commitChannel(MessageChannelEdit) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

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

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

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

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

Events

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

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

Get announcement entity reference for given context

getChannel(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

Return a specific channel.

getChannelIds(String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

Access a list of channel ids that are defined related to the context.

getChannels() - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

Return a list of all the defined channels.

getInstance() - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

Access the component instance: special cover only method.

getLabel() - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

getMessage(Reference) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

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, Time, int, boolean, boolean, boolean) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

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.

getMessages(String, Filter, boolean, boolean) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

Return a list of messages from the provided channel (merged flag returns merged messages)

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

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

Get a summary of an Announcement Channel

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

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

messageReference(String, String, String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

Access the internal reference which can be used to access the message from within the system.

messageReference(String, String) - Static method in class org.sakaiproject.announcement.cover.AnnouncementService

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

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

REF_TYPE_MESSAGE - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService

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

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

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

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

S

SECURE_ADD - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService

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

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

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

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

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

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

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

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

SECURE_READ - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService

SECURE_READ_DRAFT - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService

SECURE_REMOVE_ANY - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService

SECURE_REMOVE_OWN - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService

SECURE_UPDATE_ANY - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService

SECURE_UPDATE_OWN - Static variable in class org.sakaiproject.announcement.cover.AnnouncementService

setSubject(String) - Method in interface org.sakaiproject.announcement.api.AnnouncementMessageHeaderEdit

Set the subject of the announcement.

A C E G I M O R S