IPortalEventObserver

All Known Implementing Classes:

AbstractPortalEventObserver, ActivityDocumentObserver, ActivityStreamBigDataInitObserver, AutoAdministrationObserver, ClearDouiRestCacheEventObserver, ClusterMembershipObserver, CommandPaletteBigDataInitializedEventObserver, CommentItContentDeleteObserver, ContentIndexerObserver, ContentUrlUpdateObserver, DouiBigDataUtil.DouiBigDataInitObserver, HtmlInjectorEventObserver, HtmlProcessorEventObserver, LikeItContentDeleteObserver, LocalizationCacheClearObserver, MicroblogPortalObserver, MonitorBigDataInitObserver, PageBlockRenderDataChangedObserver, PageCacheObserver, PagePersonalizationObserver, RssObserver, ServiceInterfaceInstanceDeleteObserver, ServiceInterfaceInstanceObserver, SocialProfilePortalObserver, UserPostContentPublicationUpdateObserver, WebFileReplicationObserver, WidgetRenderDataChangedObserver
```
@StableMinor(version="14.2",
             sinceVersion="4.2")
public interface IPortalEventObserver
```
An observer of IPortalEvent's. All portal event observer implementations must implement this interface.
Instead of implementing this class directly, consider extending AbstractPortalEventObserver.

Since:

4.1.0

Version:

$Revision: 24985 $ $Date: 2022-05-02 23:04:30 -0300 (Mon, 02 May 2022) $

See Also:

lumis.portal.event

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`IPortalEventFilter`	`getEventFilter()`	Returns the event filter for this observer.
`void`	`onEvent(IPortalEvent event)`	Notifies that an event has been raised.

- Method Detail
  - getEventFilter
```
IPortalEventFilter getEventFilter()
```
    Returns the event filter for this observer.
    PortalEventFilters provides methods for generating commonly used filters.
    
    Returns:
    
    a collection of event group identifiers.
    
    Since:
    
    4.1.0
    
    See Also:
    
    PortalEventFilters
  - onEvent
```
void onEvent(IPortalEvent event)
      throws PortalException
```
    Notifies that an event has been raised. This method will be called only for events that belong to the groups specified by #getExpectedEventGroups().
    Important: The implementation of this method must not be time consuming, as it may impact the overall time response of the portal.
    
    Parameters:
    
    event - the event.
    
    Throws:
    
    PortalException
    
    Since:
    
    4.1.0