Package lumis.portal.event

Interface IPortalEvent

All Known Implementing Classes:

AbstractPortalEvent, AbstractTransactionalPortalEvent, ActivityDocumentAddedEvent, AiConfigUpdatedEvent, BigDataRepositoryInitializedEvent, BigDataRepositoryPreDestroyEvent, ChannelRenderDataChangedEvent, ClusterFileSystemAddEvent, ClusterFileSystemDeleteEvent, ClusterFileSystemUpdateEvent, ClusterMembershipChangedEvent, ClusterMessageReceivedEvent, ContentRenderDataChangedEvent, FileSystemAddEvent, FileSystemDeleteEvent, FileSystemEvent, FileSystemUpdateEvent, PageRenderDataChangedEvent, PersistenceEvent, PostAddEvent, PostDeleteEvent, PostLoadEvent, PostUpdateEvent, PreAddEvent, PreDeleteEvent, PreLoadEvent, PreUpdateEvent, ServiceInstanceRenderDataChangedEvent, ServiceInterfaceInstanceRenderDataChangedEvent, ServiceRenderDataChangedEvent, SessionEvent, SessionExpiredEvent, SessionLoginEvent, SessionLogoutEvent, SourceAddDataEvent, SourceDeleteDataEvent, SourcePostAddDataEvent, SourcePostDeleteDataEvent, SourcePostUpdateDataEvent, SourcePreAddDataEvent, SourcePreDeleteDataEvent, SourcePreUpdateDataEvent, SourceUpdateDataEvent, WorkflowActionExecutedEvent

@StableMinor(version="17.0",
             sinceVersion="4.2")
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

Version:

$Revision$ $Date$

See Also:

IPortalEventManager.notifyObservers(IPortalEvent), AbstractPortalEvent, AbstractTransactionalPortalEvent

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.String>	getEventGroups()	Returns the event group identifiers for which this event was raised.
PortalEventOperationType	getOperationType()	Returns the type of operation that generated this event.
java.lang.String	toString()	Returns a string representation for this event.

Method Detail

getEventGroups

java.util.Set<java.lang.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

java.lang.String toString()

Returns a string representation for this event. This representation is mostly suited for debugging and logging.

Overrides:

toString in class java.lang.Object

Returns:

a string representation for this event.

Since:

4.1.0