lumis.portal.event
Interface IPortalEvent

Package class diagram package IPortalEvent
All Known Implementing Classes:
AbstractPortalEvent, AbstractTransactionalPortalEvent, BaseNotificationConfig, ChannelRenderDataChangedEvent, ClusterMembershipChangedEvent, ClusterMessageReceivedEvent, FileSystemAddEvent, FileSystemDeleteEvent, FileSystemEvent, FileSystemUpdateEvent, PageRenderDataChangedEvent, PersistenceEvent, PostAddEvent, PostDeleteEvent, PostLoadEvent, PostUpdateEvent, PreAddEvent, PreDeleteEvent, PreLoadEvent, PreUpdateEvent, ServiceInstanceRenderDataChangedEvent, ServiceInterfaceInstanceRenderDataChangedEvent, SessionEvent, SessionExpiredEvent, SessionLoginEvent, SessionLogoutEvent

public interface IPortalEvent

All portal events must implement this interface. Instead of implementing this interface directly, consider extending one of the available abstract classes.

Events belongs to a set of groups, as returned by the getEventGroups() method. The definition of what is a group is open-ended, and each event implementation may use its own definition. An event may also not belong to any group at its own discretion, by returning an empty set.

Since:
4.1.0
See Also:
IPortalEventManager.notifyObservers(IPortalEvent), AbstractPortalEvent, AbstractTransactionalPortalEvent

Method Summary
 Set<String> getEventGroups()
          Returns the event group identifiers for which this event was raised.
 PortalEventOperationType getOperationType()
          Returns the type of operation that generated this event.
 String toString()
          Returns a string representation for this event.
 

Method Detail

getEventGroups

Set<String> getEventGroups()
Returns the event group identifiers for which this event was raised. The possible groups for each event may be defined by each event implementation.

Returns:
this event's groups. Must never return null, but may return an empty set to indicate that this event does not belong to any group.
Since:
4.1.0

getOperationType

PortalEventOperationType getOperationType()
Returns the type of operation that generated this event.

Returns:
the type of operation that generated this event.
Since:
4.1.0

toString

String toString()
Returns a string representation for this event. This representation is mostly suited for debugging and logging.

Overrides:
toString in class Object
Returns:
a string representation for this event.
Since:
4.1.0


Lumisportal  4.1.0.071221 - Copyright © 2001-2007, Lumis. All Rights Reserved.