BaseAnnouncementService (sakai-announcement-impl 11.1 API)

java.lang.Object
- org.sakaiproject.message.util.BaseMessage
- - org.sakaiproject.announcement.impl.BaseAnnouncementService

All Implemented Interfaces:

AnnouncementService, ContextObserver, EntityProducer, EntitySummary, EntityTransferrer, EntityTransferrerRefMigrator, MessageService, DoubleStorageUser, SingleStorageUser

Direct Known Subclasses:

DbAnnouncementService
```
public abstract class BaseAnnouncementService
extends BaseMessage
implements AnnouncementService, ContextObserver, EntityTransferrer, EntityTransferrerRefMigrator
```
BaseAnnouncementService extends the BaseMessage for the specifics of Announcement.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`BaseAnnouncementService.BaseAnnouncementChannelEdit` AnnouncementChannel implementation
`class`	`BaseAnnouncementService.BaseAnnouncementMessageEdit` AnnouncementMessage implementation
`class`	`BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit` AnnouncementMessageHeaderEdit implementation
`protected class`	`BaseAnnouncementService.PrivacyFilter` A filter that will reject announcement message drafts not from the current user, and otherwise use another filter, if defined, for acceptance.

Nested classes/interfaces inherited from class org.sakaiproject.message.util.BaseMessage
BaseMessage.BaseMessageChannelEdit, BaseMessage.BaseMessageEdit, BaseMessage.BaseMessageHeaderEdit, BaseMessage.MessagePermissionFilter, BaseMessage.MessageSelectionFilter, BaseMessage.NotifyThread, BaseMessage.PublicFilter, BaseMessage.Storage

Field Summary

Fields
Modifier and Type	Field and Description
`protected NotificationService`	`m_notificationService` Dependency: NotificationService.
`protected static ResourceLoader`	`rb` Messages, for the http access.

Fields inherited from class org.sakaiproject.message.util.BaseMessage
m_authzGroupService, m_entityManager, m_eventTrackingService, m_idManager, m_memoryService, m_securityService, m_serverConfigurationService, m_sessionManager, m_siteService, m_storage, m_threadLocalManager, m_timeService, m_userDirectoryService

Fields inherited from interface org.sakaiproject.announcement.api.AnnouncementService
ANNOUNCEMENT_CHANNEL_PROPERTY, APPLICATION_ID, ASSIGNMENT_REFERENCE, EVENT_ANNC_UPDATE_ACCESS, EVENT_ANNC_UPDATE_AVAILABILITY, EVENT_ANNC_UPDATE_TITLE, MOD_DATE, REF_TYPE_ANNOUNCEMENT, REF_TYPE_ANNOUNCEMENT_RSS, REFERENCE_ROOT, RELEASE_DATE, RETRACT_DATE, SECURE_ANNC_ADD, SECURE_ANNC_ALL_GROUPS, SECURE_ANNC_READ, SECURE_ANNC_READ_DRAFT, SECURE_ANNC_REMOVE_ANY, SECURE_ANNC_REMOVE_OWN, SECURE_ANNC_ROOT, SECURE_ANNC_UPDATE_ANY, SECURE_ANNC_UPDATE_OWN

Fields inherited from interface org.sakaiproject.message.api.MessageService
REF_TYPE_CHANNEL, REF_TYPE_MESSAGE, SECURE_ADD, SECURE_ALL_GROUPS, SECURE_CREATE, SECURE_READ, SECURE_READ_DRAFT, SECURE_REMOVE_ANY, SECURE_REMOVE_OWN, SECURE_UPDATE_ANY, SECURE_UPDATE_OWN

Constructor Summary

Constructors
Constructor and Description

BaseAnnouncementService()

Constructors
Constructor and Description
`BaseAnnouncementService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnnouncementChannelEdit`	`addAnnouncementChannel(String ref)` Add a new announcement channel.
`String`	`channelReference(String context, String id)`
`void`	`clearMessagesCache(String channelRef)`
`void`	`contextCreated(String context, boolean toolPlacement)`
`void`	`contextDeleted(String context, boolean toolPlacement)`
`void`	`contextUpdated(String context, boolean toolPlacement)`
`protected String`	`eventId(String secure)` Form a tracking event string based on a security function string.
`protected Element`	`generateItemElement(Document doc, AnnouncementMessage msg, Reference msgRef)` Generate RSS Item element for specified assignment
`AnnouncementChannel`	`getAnnouncementChannel(String ref)` Return a specific announcement channel.
`Reference`	`getAnnouncementReference(String context)`
`Time`	`getDate(Entity r)` Access the resource date.
`HttpAccess`	`getHttpAccess()`
`String`	`getLabel()`
`Integer`	`getMessage_order(Entity r)` Access the resource Message Order.
`List`	`getMessages(String channelReference, Filter filter, boolean order, boolean merged)` Return a list of messages from the provided channel (merged flag returns merged messages)
`String`	`getOwnerId(Entity r)` Access the resource owner user id.
`protected String`	`getReferenceRoot()` Return the reference rooot for use in resource references and urls.
`String`	`getRssUrl(Reference ref)`
`String`	`getSummarizableReference(String siteId, String toolIdentifier)`
`protected String`	`getSummaryFromHeader(Message item, MessageHeader header)` getSummaryFromHeader implementation
`void`	`init()` Final initialization, once all dependencies are set.
`boolean`	`isDraft(Entity r)` Check if this resource is in draft mode.
`boolean`	`isMessageViewable(AnnouncementMessage message)`
`String[]`	`myToolIds()`
`Entity`	`newContainer(Element element)` Construct a new container resource, from an XML element.
`Entity`	`newContainer(Entity other)` Construct a new container resource, as a copy of another
`Entity`	`newContainer(String ref)` Construct a new continer given just ids.
`Edit`	`newContainerEdit(Element element)` Construct a new container resource, from an XML element.
`Edit`	`newContainerEdit(Entity other)` Construct a new container resource, as a copy of another
`Edit`	`newContainerEdit(String ref)` Construct a new continer given just ids.
`protected MessageHeaderEdit`	`newMessageHeader(Message msg, Element el)` Construct a new message header from XML in a DOM element.
`protected MessageHeaderEdit`	`newMessageHeader(Message msg, MessageHeader other)` Construct a new message header as a copy of another.
`protected MessageHeaderEdit`	`newMessageHeader(Message msg, String id)` Construct a new message header from XML in a DOM element.
`Entity`	`newResource(Entity container, Element element)` Construct a new resource, from an XML element.
`Entity`	`newResource(Entity container, Entity other)` Construct a new resource from another resource of the same type.
`Entity`	`newResource(Entity container, String id, Object[] others)` Construct a new rsource given just an id.
`Edit`	`newResourceEdit(Entity container, Element element)` Construct a new resource, from an XML element.
`Edit`	`newResourceEdit(Entity container, Entity other)` Construct a new resource from another resource of the same type.
`Edit`	`newResourceEdit(Entity container, String id, Object[] others)` Construct a new rsource given just an id.
`boolean`	`parseEntityReference(String reference, Reference ref)`
`protected void`	`printAnnouncementHtml(PrintWriter out, Reference ref)` Print specified Announcement as HTML Page
`protected void`	`printAnnouncementRss(OutputStream out, Reference rssRef)` Print all Announcements as RSS Feed
`protected String`	`serviceName()` Report the Service API name being implemented.
`void`	`setAliasService(AliasService aliasService)`
`void`	`setContentHostingService(ContentHostingService service)` Dependency: contentHostingService.
`void`	`setFunctionManager(FunctionManager functionManager)`
`void`	`setNotificationService(NotificationService service)` Dependency: NotificationService.
`void`	`setSiteEmailNotificationAnnc(SiteEmailNotificationAnnc siteEmailNotificationAnnc)`
`void`	`setToolManager(ToolManager toolManager)`
`Object[]`	`storageFields(Entity r)` Collect the fields that need to be stored outside the XML (for the resource).
`String[]`	`summarizableToolIds()`
`void`	`transferCopyEntities(String fromContext, String toContext, List resourceIds)`
`void`	`transferCopyEntities(String fromContext, String toContext, List ids, boolean cleanup)`
`Map<String,String>`	`transferCopyEntitiesRefMigrator(String fromContext, String toContext, List resourceIds)`
`Map<String,String>`	`transferCopyEntitiesRefMigrator(String fromContext, String toContext, List ids, boolean cleanup)`
`void`	`updateEntityReferences(String toContext, Map<String,String> transversalMap)`

Methods inherited from class org.sakaiproject.message.util.BaseMessage
addChannel, allowAddChannel, allowEditChannel, allowGetChannel, allowGetMessage, allowGetMessage, allowRemoveChannel, archive, archiveSynopticOptions, cancelChannel, cancelMessage, canSeeAllGroups, commitChannel, destroy, disableMessageChannel, editChannel, enableMessageChannel, filterGroupAccess, findChannel, getAccessPoint, getChannel, getChannelIds, getChannelPublic, getChannels, getEntity, getEntityAuthzGroups, getEntityDescription, getEntityResourceProperties, getEntityUrl, getGroupsAllowFunction, getMessage, getMessages, getSummary, isIntersectionGroupRefsToGroups, merge, messageReference, messageReference, newStorage, parseMergeChannelExtra, removeChannel, service, setAuthzGroupService, setCaching, setEntityManager, setEventTrackingService, setIdManager, setMemoryService, setSecurityService, setServerConfigurationService, setSessionManager, setSiteService, setThreadLocalManager, setTimeService, setUserDirectoryService, transferSynopticOptions, unlock, unlock2, unlock3, unlockCheck, unlockCheck2, unlockCheck3, willArchiveMerge

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.sakaiproject.message.api.MessageService
addChannel, allowAddChannel, allowEditChannel, allowGetChannel, allowRemoveChannel, cancelChannel, cancelMessage, commitChannel, editChannel, getChannel, getChannelIds, getChannelPublic, getChannels, getMessage, getMessages, getSummary, messageReference, messageReference, removeChannel

Methods inherited from interface org.sakaiproject.entity.api.EntityProducer
archive, getEntity, getEntityAuthzGroups, getEntityDescription, getEntityResourceProperties, getEntityUrl, merge, willArchiveMerge

- Field Detail
  - rb
```
protected static ResourceLoader rb
```
    Messages, for the http access.
  - m_notificationService
```
protected NotificationService m_notificationService
```
    Dependency: NotificationService.
- Constructor Detail
  - BaseAnnouncementService
```
public BaseAnnouncementService()
```
- Method Detail
  - setContentHostingService
```
public void setContentHostingService(ContentHostingService service)
```
    Dependency: contentHostingService.
    
    Parameters:
    
    service - The NotificationService.
  - setSiteEmailNotificationAnnc
```
public void setSiteEmailNotificationAnnc(SiteEmailNotificationAnnc siteEmailNotificationAnnc)
```
  - setFunctionManager
```
public void setFunctionManager(FunctionManager functionManager)
```
  - setAliasService
```
public void setAliasService(AliasService aliasService)
```
  - setToolManager
```
public void setToolManager(ToolManager toolManager)
```
  - setNotificationService
```
public void setNotificationService(NotificationService service)
```
    Dependency: NotificationService.
    
    Parameters:
    
    service - The NotificationService.
  - init
```
public void init()
```
    Final initialization, once all dependencies are set.
    
    Overrides:
    
    init in class BaseMessage
  - newContainer
```
public Entity newContainer(String ref)
```
    Construct a new continer given just ids.
    
    Specified by:
    
    newContainer in interface DoubleStorageUser
    
    Parameters:
    
    ref - The container reference.
    
    Returns:
    
    The new containe Resource.
  - newContainer
```
public Entity newContainer(Element element)
```
    Construct a new container resource, from an XML element.
    
    Specified by:
    
    newContainer in interface DoubleStorageUser
    
    Parameters:
    
    element - The XML.
    
    Returns:
    
    The new container resource.
  - newContainer
```
public Entity newContainer(Entity other)
```
    Construct a new container resource, as a copy of another
    
    Specified by:
    
    newContainer in interface DoubleStorageUser
    
    Parameters:
    
    other - The other contianer to copy.
    
    Returns:
    
    The new container resource.
  - newResource
```
public Entity newResource(Entity container,
                          String id,
                          Object[] others)
```
    Construct a new rsource given just an id.
    
    Specified by:
    
    newResource in interface SingleStorageUser
    
    Parameters:
    
    container - The Resource that is the container for the new resource (may be null).
    
    id - The id for the new object.
    
    others - (options) array of objects to load into the Resource's fields.
    
    Returns:
    
    The new resource.
  - newResource
```
public Entity newResource(Entity container,
                          Element element)
```
    Construct a new resource, from an XML element.
    
    Specified by:
    
    newResource in interface SingleStorageUser
    
    Parameters:
    
    container - The Resource that is the container for the new resource (may be null).
    
    element - The XML.
    
    Returns:
    
    The new resource from the XML.
  - newResource
```
public Entity newResource(Entity container,
                          Entity other)
```
    Construct a new resource from another resource of the same type.
    
    Specified by:
    
    newResource in interface SingleStorageUser
    
    Parameters:
    
    container - The Resource that is the container for the new resource (may be null).
    
    other - The other resource.
    
    Returns:
    
    The new resource as a copy of the other.
  - newContainerEdit
```
public Edit newContainerEdit(String ref)
```
    Construct a new continer given just ids.
    
    Specified by:
    
    newContainerEdit in interface DoubleStorageUser
    
    Parameters:
    
    ref - The container reference.
    
    Returns:
    
    The new containe Resource.
  - newContainerEdit
```
public Edit newContainerEdit(Element element)
```
    Construct a new container resource, from an XML element.
    
    Specified by:
    
    newContainerEdit in interface DoubleStorageUser
    
    Parameters:
    
    element - The XML.
    
    Returns:
    
    The new container resource.
  - newContainerEdit
```
public Edit newContainerEdit(Entity other)
```
    Construct a new container resource, as a copy of another
    
    Specified by:
    
    newContainerEdit in interface DoubleStorageUser
    
    Parameters:
    
    other - The other contianer to copy.
    
    Returns:
    
    The new container resource.
  - newResourceEdit
```
public Edit newResourceEdit(Entity container,
                            String id,
                            Object[] others)
```
    Construct a new rsource given just an id.
    
    Specified by:
    
    newResourceEdit in interface SingleStorageUser
    
    Parameters:
    
    container - The Resource that is the container for the new resource (may be null).
    
    id - The id for the new object.
    
    others - (options) array of objects to load into the Resource's fields.
    
    Returns:
    
    The new resource.
  - newResourceEdit
```
public Edit newResourceEdit(Entity container,
                            Element element)
```
    Construct a new resource, from an XML element.
    
    Specified by:
    
    newResourceEdit in interface SingleStorageUser
    
    Parameters:
    
    container - The Resource that is the container for the new resource (may be null).
    
    element - The XML.
    
    Returns:
    
    The new resource from the XML.
  - newResourceEdit
```
public Edit newResourceEdit(Entity container,
                            Entity other)
```
    Construct a new resource from another resource of the same type.
    
    Specified by:
    
    newResourceEdit in interface SingleStorageUser
    
    Parameters:
    
    container - The Resource that is the container for the new resource (may be null).
    
    other - The other resource.
    
    Returns:
    
    The new resource as a copy of the other.
  - storageFields
```
public Object[] storageFields(Entity r)
```
    Collect the fields that need to be stored outside the XML (for the resource).
    
    Specified by:
    
    storageFields in interface SingleStorageUser
    
    Returns:
    
    An array of field values to store in the record outside the XML (for the resource).
  - isDraft
```
public boolean isDraft(Entity r)
```
    Check if this resource is in draft mode.
    
    Specified by:
    
    isDraft in interface DoubleStorageUser
    
    Parameters:
    
    r - The resource.
    
    Returns:
    
    true if the resource is in draft mode, false if not.
  - getOwnerId
```
public String getOwnerId(Entity r)
```
    Access the resource owner user id.
    
    Specified by:
    
    getOwnerId in interface DoubleStorageUser
    
    Parameters:
    
    r - The resource.
    
    Returns:
    
    The resource owner user id.
  - getDate
```
public Time getDate(Entity r)
```
    Access the resource date.
    
    Specified by:
    
    getDate in interface DoubleStorageUser
    
    Parameters:
    
    r - The resource.
    
    Returns:
    
    The resource date.
  - getMessage_order
```
public Integer getMessage_order(Entity r)
```
    Access the resource Message Order.
    
    Parameters:
    
    r - The resource.
    
    Returns:
    
    The resource order.
  - serviceName
```
protected String serviceName()
```
    Report the Service API name being implemented.
    
    Specified by:
    
    serviceName in class BaseMessage
  - newMessageHeader
```
protected MessageHeaderEdit newMessageHeader(Message msg,
                                             String id)
```
    Construct a new message header from XML in a DOM element.
    
    Specified by:
    
    newMessageHeader in class BaseMessage
    
    Parameters:
    
    id - The message Id.
    
    Returns:
    
    The new message header.
  - newMessageHeader
```
protected MessageHeaderEdit newMessageHeader(Message msg,
                                             Element el)
```
    Construct a new message header from XML in a DOM element.
    
    Specified by:
    
    newMessageHeader in class BaseMessage
    
    Parameters:
    
    el - The XML DOM element that has the header information.
    
    Returns:
    
    The new message header.
  - newMessageHeader
```
protected MessageHeaderEdit newMessageHeader(Message msg,
                                             MessageHeader other)
```
    Construct a new message header as a copy of another.
    
    Specified by:
    
    newMessageHeader in class BaseMessage
    
    Parameters:
    
    other - The other header to copy.
    
    Returns:
    
    The new message header.
  - eventId
```
protected String eventId(String secure)
```
    Form a tracking event string based on a security function string.
    
    Specified by:
    
    eventId in class BaseMessage
    
    Parameters:
    
    secure - The security function string. NOTE: if this input is null or blank then event id will default to "annc.INVALID_KEY", this is only because throwing an exception here would be very disruptive and returning a null or blank for the event id would cause other failures (SAK-23804)
    
    Returns:
    
    The event tracking string.
  - getReferenceRoot
```
protected String getReferenceRoot()
```
    Return the reference rooot for use in resource references and urls.
    
    Specified by:
    
    getReferenceRoot in class BaseMessage
    
    Returns:
    
    The reference rooot for use in resource references and urls.
  - parseEntityReference
```
public boolean parseEntityReference(String reference,
                                    Reference ref)
```
    Specified by:
    
    parseEntityReference in interface EntityProducer
  - getAnnouncementReference
```
public Reference getAnnouncementReference(String context)
```
    Specified by:
    
    getAnnouncementReference in interface AnnouncementService
  - channelReference
```
public String channelReference(String context,
                               String id)
```
    Specified by:
    
    channelReference in interface MessageService
    
    Overrides:
    
    channelReference in class BaseMessage
  - getRssUrl
```
public String getRssUrl(Reference ref)
```
    Specified by:
    
    getRssUrl in interface AnnouncementService
  - isMessageViewable
```
public boolean isMessageViewable(AnnouncementMessage message)
```
    Specified by:
    
    isMessageViewable in interface AnnouncementService
  - contextCreated
```
public void contextCreated(String context,
                           boolean toolPlacement)
```
    Specified by:
    
    contextCreated in interface ContextObserver
  - contextUpdated
```
public void contextUpdated(String context,
                           boolean toolPlacement)
```
    Specified by:
    
    contextUpdated in interface ContextObserver
  - contextDeleted
```
public void contextDeleted(String context,
                           boolean toolPlacement)
```
    Specified by:
    
    contextDeleted in interface ContextObserver
  - myToolIds
```
public String[] myToolIds()
```
    Specified by:
    
    myToolIds in interface ContextObserver
    
    Specified by:
    
    myToolIds in interface EntityTransferrer
  - generateItemElement
```
protected Element generateItemElement(Document doc,
                                      AnnouncementMessage msg,
                                      Reference msgRef)
```
    Generate RSS Item element for specified assignment
  - printAnnouncementRss
```
protected void printAnnouncementRss(OutputStream out,
                                    Reference rssRef)
```
    Print all Announcements as RSS Feed
  - printAnnouncementHtml
```
protected void printAnnouncementHtml(PrintWriter out,
                                     Reference ref)
                              throws EntityPermissionException,
                                     EntityNotDefinedException
```
    Print specified Announcement as HTML Page
    
    Throws:
    
    EntityPermissionException
    
    EntityNotDefinedException
  - getHttpAccess
```
public HttpAccess getHttpAccess()
```
    Specified by:
    
    getHttpAccess in interface EntityProducer
    
    Overrides:
    
    getHttpAccess in class BaseMessage
  - getAnnouncementChannel
```
public AnnouncementChannel getAnnouncementChannel(String ref)
                                           throws IdUnusedException,
                                                  PermissionException
```
    Return a specific announcement channel.
    
    Specified by:
    
    getAnnouncementChannel in interface AnnouncementService
    
    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
```
    Add a new announcement channel.
    
    Specified by:
    
    addAnnouncementChannel in interface AnnouncementService
    
    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.
  - getMessages
```
public List getMessages(String channelReference,
                        Filter filter,
                        boolean order,
                        boolean merged)
                 throws IdUnusedException,
                        PermissionException,
                        NullPointerException
```
    Return a list of messages from the provided channel (merged flag returns merged messages)
    
    Specified by:
    
    getMessages in interface AnnouncementService
    
    Parameters:
    
    channelReference - Channel's reference String
    
    filter - A filtering object to accept messages, or null if no filtering is desired.
    
    order - Order of messages, ascending if true, descending if false
    
    merged - flag to include merged channel messages, true returns ALL messages including merged sites/channels
    
    Returns:
    
    a list of Message objects or specializations of Message objects (may be empty).
    
    Throws:
    
    IdUnusedException - If this name is not defined for a announcement channel.
    
    PermissionException - if the user does not have read permission to the channel.
    
    NullPointerException
  - getLabel
```
public String getLabel()
```
    Specified by:
    
    getLabel in interface EntityProducer
  - getSummaryFromHeader
```
protected String getSummaryFromHeader(Message item,
                                      MessageHeader header)
```
    getSummaryFromHeader implementation
    
    Overrides:
    
    getSummaryFromHeader in class BaseMessage
  - transferCopyEntities
```
public void transferCopyEntities(String fromContext,
                                 String toContext,
                                 List resourceIds)
```
    Specified by:
    
    transferCopyEntities in interface EntityTransferrer
  - transferCopyEntitiesRefMigrator
```
public Map<String,String> transferCopyEntitiesRefMigrator(String fromContext,
                                                          String toContext,
                                                          List resourceIds)
```
    Specified by:
    
    transferCopyEntitiesRefMigrator in interface EntityTransferrerRefMigrator
  - updateEntityReferences
```
public void updateEntityReferences(String toContext,
                                   Map<String,String> transversalMap)
```
    Specified by:
    
    updateEntityReferences in interface EntityTransferrerRefMigrator
  - summarizableToolIds
```
public String[] summarizableToolIds()
```
    Specified by:
    
    summarizableToolIds in interface EntitySummary
  - getSummarizableReference
```
public String getSummarizableReference(String siteId,
                                       String toolIdentifier)
```
    Specified by:
    
    getSummarizableReference in interface EntitySummary
    
    Overrides:
    
    getSummarizableReference in class BaseMessage
  - transferCopyEntities
```
public void transferCopyEntities(String fromContext,
                                 String toContext,
                                 List ids,
                                 boolean cleanup)
```
    Specified by:
    
    transferCopyEntities in interface EntityTransferrer
  - transferCopyEntitiesRefMigrator
```
public Map<String,String> transferCopyEntitiesRefMigrator(String fromContext,
                                                          String toContext,
                                                          List ids,
                                                          boolean cleanup)
```
    Specified by:
    
    transferCopyEntitiesRefMigrator in interface EntityTransferrerRefMigrator
  - clearMessagesCache
```
public void clearMessagesCache(String channelRef)
```
    Specified by:
    
    clearMessagesCache in interface AnnouncementService

Class BaseAnnouncementService

Nested Class Summary

Nested classes/interfaces inherited from class org.sakaiproject.message.util.BaseMessage

Field Summary

Fields inherited from class org.sakaiproject.message.util.BaseMessage

Fields inherited from interface org.sakaiproject.announcement.api.AnnouncementService

Fields inherited from interface org.sakaiproject.message.api.MessageService

Constructor Summary

Method Summary

Methods inherited from class org.sakaiproject.message.util.BaseMessage

Methods inherited from class java.lang.Object

Methods inherited from interface org.sakaiproject.message.api.MessageService

Methods inherited from interface org.sakaiproject.entity.api.EntityProducer

Field Detail

rb

m_notificationService

Constructor Detail

BaseAnnouncementService

Method Detail

setContentHostingService

setSiteEmailNotificationAnnc

setFunctionManager

setAliasService

setToolManager

setNotificationService

init

newContainer

newContainer

newContainer

newResource

newResource

newResource

newContainerEdit

newContainerEdit

newContainerEdit

newResourceEdit

newResourceEdit

newResourceEdit

storageFields

isDraft

getOwnerId

getDate

getMessage_order

serviceName

newMessageHeader

newMessageHeader

newMessageHeader

eventId

getReferenceRoot

parseEntityReference

getAnnouncementReference

channelReference

getRssUrl

isMessageViewable

contextCreated

contextUpdated

contextDeleted

myToolIds

generateItemElement

printAnnouncementRss

printAnnouncementHtml

getHttpAccess

getAnnouncementChannel

addAnnouncementChannel

getMessages

getLabel

getSummaryFromHeader

transferCopyEntities

transferCopyEntitiesRefMigrator

updateEntityReferences

summarizableToolIds

getSummarizableReference

transferCopyEntities

transferCopyEntitiesRefMigrator

clearMessagesCache