A B C D E F G H I M N O P R S T U

A

accept(Object) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService.PrivacyFilter

Does this object satisfy the criteria of the filter?

addAnnouncementChannel(String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Add a new announcement channel.

addAnnouncementMessage() - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementChannelEdit

A (AnnouncementMessageEdit) cover for addMessage.

addAnnouncementMessage(String, boolean, List, String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementChannelEdit

a (AnnouncementMessage) cover for addMessage to add a new message to this channel.

addSpecialRecipients(List, Reference) - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

Add to the user list any other users who should be notified about this ref's change.

AnnouncementUserNotificationPreferencesRegistrationImpl - Class in org.sakaiproject.announcement.user.prefs

AnnouncementUserNotificationPreferencesRegistrationImpl() - Constructor for class org.sakaiproject.announcement.user.prefs.AnnouncementUserNotificationPreferencesRegistrationImpl

B

BaseAnnouncementService - Class in org.sakaiproject.announcement.impl

BaseAnnouncementService extends the BaseMessageService for the specifics of Announcement.

BaseAnnouncementService() - Constructor for class org.sakaiproject.announcement.impl.BaseAnnouncementService

BaseAnnouncementService.BaseAnnouncementChannelEdit - Class in org.sakaiproject.announcement.impl

AnnouncementChannel implementation

BaseAnnouncementService.BaseAnnouncementChannelEdit(String) - Constructor for class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementChannelEdit

Construct with a reference.

BaseAnnouncementService.BaseAnnouncementChannelEdit(MessageChannel) - Constructor for class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementChannelEdit

Construct as a copy of another message.

BaseAnnouncementService.BaseAnnouncementChannelEdit(Element) - Constructor for class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementChannelEdit

Construct from a channel (and possibly messages) already defined in XML in a DOM tree.

BaseAnnouncementService.BaseAnnouncementMessageEdit - Class in org.sakaiproject.announcement.impl

AnnouncementMessage implementation

BaseAnnouncementService.BaseAnnouncementMessageEdit(MessageChannel, String) - Constructor for class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementMessageEdit

Construct.

BaseAnnouncementService.BaseAnnouncementMessageEdit(MessageChannel, Message) - Constructor for class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementMessageEdit

Construct as a copy of another message.

BaseAnnouncementService.BaseAnnouncementMessageEdit(MessageChannel, Element) - Constructor for class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementMessageEdit

Construct from an existing definition, in xml.

BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit - Class in org.sakaiproject.announcement.impl

AnnouncementMessageHeaderEdit implementation

BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(Message, String) - Constructor for class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

Construct.

BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(Message, Element) - Constructor for class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

Construct, from an already existing XML DOM element.

BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(Message, MessageHeader) - Constructor for class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

Construct as a copy of another header.

BaseAnnouncementService.PrivacyFilter - Class in org.sakaiproject.announcement.impl

A filter that will reject announcement message drafts not from the current user, and otherwise use another filter, if defined, for acceptance.

BaseAnnouncementService.PrivacyFilter(Filter) - Constructor for class org.sakaiproject.announcement.impl.BaseAnnouncementService.PrivacyFilter

Construct

C

cancelChannel(MessageChannelEdit) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

cancelMessage(MessageChannel, MessageEdit) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

channelReference(String, String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

checkChannel(String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

Channels *

checkMessage(MessageChannel, String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

messages *

clearMessagesCache(String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

commitChannel(MessageChannelEdit) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

commitMessage(MessageChannel, MessageEdit) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

contextCreated(String, boolean) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

contextDeleted(String, boolean) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

contextUpdated(String, boolean) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

convertToDraft() - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService

fill in the draft and owner db fields

convertToPubView() - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService

fill in the pubview db fields

D

DbAnnouncementService - Class in org.sakaiproject.announcement.impl

DbAnnouncementService fills out the BaseAnnouncementService with a database implementation.

DbAnnouncementService() - Constructor for class org.sakaiproject.announcement.impl.DbAnnouncementService

DbAnnouncementService.DbStorage - Class in org.sakaiproject.announcement.impl

Storage implementation

DbAnnouncementService.DbStorage(StorageUser) - Constructor for class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

Construct.

disableSecurityAdvisor() - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

remove recent add SecurityAdvisor from stack

E

editAnnouncementMessage(String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementChannelEdit

A (AnnouncementMessageEdit) cover for editMessage.

editChannel(String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

editMessage(MessageChannel, String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

enableSecurityAdvisorToGetAnnouncement() - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

Establish a security advisor to allow the "embedded" azg work to occur with no need for additional security permissions.

eventId(String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Form a tracking event string based on a security function string.

execute(String) - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

Implementation of command pattern.

F

FIELDS - Static variable in class org.sakaiproject.announcement.impl.DbAnnouncementService

G

generateItemElement(Document, AnnouncementMessage, Reference) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Generate RSS Item element for specified assignment

getAnnouncementChannel(String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Return a specific announcement channel.

getAnnouncementHeader() - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementMessageEdit

Access the announcement message header.

getAnnouncementHeaderEdit() - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementMessageEdit

Access the announcement message header.

getAnnouncementMessage(String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementChannelEdit

Return a specific announcement channel message, as specified by message name.

getAnnouncementReference(String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

getChannel(String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

getChannelIdsMatching(String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

getChannels() - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

getCount(MessageChannel) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

getCount(MessageChannel, Filter) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

getDate(Entity) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Access the resource date.

getFromAddress(Event) - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

Format the announcement notification from address.

getHeaders(Event) - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

getHttpAccess() - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

getLabel() - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

getMessage(MessageChannel, String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

getMessage_order(Entity) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Access the resource Message Order.

getMessages(Filter, boolean) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementChannelEdit

Return a list of all or filtered messages in the channel.

getMessages(String, Filter, boolean, boolean) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

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

getMessages(MessageChannel) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

getMessages(MessageChannel, Filter, boolean, PagingPosition) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

getMessages(MessageChannel, Time, int, String, boolean) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

getOwnerId(Entity) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Access the resource owner user id.

getPubView(String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService

Does this resource support public view?

getReferenceRoot() - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Return the reference rooot for use in resource references and urls.

getResourceAbility() - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

getResourceLoader(String) - Method in class org.sakaiproject.announcement.user.prefs.AnnouncementUserNotificationPreferencesRegistrationImpl

getRssUrl(Reference) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

getSubject() - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

Access the subject of the announcement.

getSubject(Event) - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

Format the announcement notification subject line.

getSummarizableReference(String, String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

getSummaryFromHeader(Message, MessageHeader) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

getSummaryFromHeader implementation

getTag(String, boolean) - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

H

htmlContent(Event) - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

I

init() - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Final initialization, once all dependencies are set.

init() - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService

Final initialization, once all dependencies are set.

isDraft(Entity) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Check if this resource is in draft mode.

isMessageViewable(AnnouncementMessage) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

M

m_autoDdl - Variable in class org.sakaiproject.announcement.impl.DbAnnouncementService

Configuration: to run the ddl on init or not.

m_convertToDraft - Variable in class org.sakaiproject.announcement.impl.DbAnnouncementService

Set if we are to run the to-draft/owner conversion.

m_convertToPubView - Variable in class org.sakaiproject.announcement.impl.DbAnnouncementService

Set if we are to run the to-pubview conversion.

m_cTableName - Variable in class org.sakaiproject.announcement.impl.DbAnnouncementService

The name of the db table holding announcement channels.

m_filter - Variable in class org.sakaiproject.announcement.impl.BaseAnnouncementService.PrivacyFilter

The other filter to check with.

m_locksInDb - Variable in class org.sakaiproject.announcement.impl.DbAnnouncementService

If true, we do our locks in the remote database, otherwise we do them here.

m_notificationService - Variable in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Dependency: NotificationService.

m_rTableName - Variable in class org.sakaiproject.announcement.impl.DbAnnouncementService

The name of the db table holding announcement messages.

m_sqlService - Variable in class org.sakaiproject.announcement.impl.DbAnnouncementService

Dependency: SqlService

m_subject - Variable in class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

The subject for the announcement.

makeEmailNotification() - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

myToolIds() - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

N

newContainer(String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new continer given just ids.

newContainer(Element) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new container resource, from an XML element.

newContainer(Entity) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new container resource, as a copy of another

newContainerEdit(String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new continer given just ids.

newContainerEdit(Element) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new container resource, from an XML element.

newContainerEdit(Entity) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new container resource, as a copy of another

newMessageHeader(Message, String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new message header from XML in a DOM element.

newMessageHeader(Message, Element) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new message header from XML in a DOM element.

newMessageHeader(Message, MessageHeader) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new message header as a copy of another.

newResource(Entity, String, Object[]) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new rsource given just an id.

newResource(Entity, Element) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new resource, from an XML element.

newResource(Entity, Entity) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new resource from another resource of the same type.

newResourceEdit(Entity, String, Object[]) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new rsource given just an id.

newResourceEdit(Entity, Element) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new resource, from an XML element.

newResourceEdit(Entity, Entity) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Construct a new resource from another resource of the same type.

newStorage() - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService

Construct a Storage object.

notify(Notification, Event) - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

O

org.sakaiproject.announcement.impl - package org.sakaiproject.announcement.impl

org.sakaiproject.announcement.user.prefs - package org.sakaiproject.announcement.user.prefs

P

parseEntityReference(String, Reference) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

plainTextContent(Event) - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

printAnnouncementHtml(PrintWriter, Reference) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Print specified Announcement as HTML Page

printAnnouncementRss(OutputStream, Reference) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Print all Announcements as RSS Feed

putChannel(String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

putMessage(MessageChannel, String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

R

rb - Static variable in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Messages, for the http access.

removeAnnouncementMessage(String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementChannelEdit

A cover for removeMessage.

removeChannel(MessageChannelEdit) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

removeMessage(MessageChannel, MessageEdit) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService.DbStorage

S

serviceName() - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Report the Service API name being implemented.

setAliasService(AliasService) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

setAuthzGroupService(AuthzGroupService) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService

setAutoDdl(String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService

Configuration: to run the ddl on init or not.

setContainerTableName(String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService

Configuration: set the table name for the container.

setContentHostingService(ContentHostingService) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Dependency: contentHostingService.

setConvertDraft(String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService

Configuration: run the to-draft/owner conversion

setConvertPubView(String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService

Configuration: run the to-pubview conversion

setFunctionManager(FunctionManager) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

setLocksInDb(String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService

Configuration: set the locks-in-db

setNotificationService(NotificationService) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Dependency: NotificationService.

setResourceTableName(String) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService

Configuration: set the table name for the resource.

setScheduledInvocationManager(ScheduledInvocationManager) - Method in class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

Inject ScheudledInvocationManager

setSecurityService(SecurityService) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

setSessionManager(SessionManager) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

setSqlService(SqlService) - Method in class org.sakaiproject.announcement.impl.DbAnnouncementService

Dependency: SqlService.

setSubject(String) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

Set the subject of the announcement.

setTimeService(TimeService) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

setToolManager(ToolManager) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

SiteEmailNotificationAnnc - Class in org.sakaiproject.announcement.impl

SiteEmailNotificationAnnc fills the notification message and headers with details from the announcement message that triggered the notification event.

SiteEmailNotificationAnnc() - Constructor for class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

Construct.

SiteEmailNotificationAnnc(String) - Constructor for class org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc

Construct.

storageFields(Entity) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

Collect the fields that need to be stored outside the XML (for the resource).

summarizableToolIds() - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

T

toXml(Document, Stack) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

Serialize the resource into XML, adding an element to the doc under the top of the stack element.

transferCopyEntities(String, String, List) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

transferCopyEntities(String, String, List, boolean) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

transferCopyEntitiesRefMigrator(String, String, List) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

transferCopyEntitiesRefMigrator(String, String, List, boolean) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

U

updateEntityReferences(String, Map<String, String>) - Method in class org.sakaiproject.announcement.impl.BaseAnnouncementService

A B C D E F G H I M N O P R S T U