Package lumis.portal.event

Class AbstractPortalEvent

java.lang.Object

lumis.portal.event.AbstractPortalEvent

All Implemented Interfaces:

IPortalEvent

Direct Known Subclasses:

AbstractTransactionalPortalEvent, ActivityDocumentAddedEvent, AiConfigUpdatedEvent, BigDataRepositoryInitializedEvent, BigDataRepositoryPreDestroyEvent, ClusterMembershipChangedEvent, ClusterMessageReceivedEvent, FileSystemEvent

@StableMinor(version="17.0",
             sinceVersion="4.2")
public abstract class AbstractPortalEvent
extends java.lang.Object
implements IPortalEvent

An abstract implementation for IPortalEvent. It is recommended to extend this class instead of implementing the interface directly.

This implementation initializes getOperationType() as PortalEventOperationType.UNDEFINED and getEventGroups() as and empty set. Subclasses may call the set methods (preferably inside the constructor) or override the get methods to change these default values.

Since:

4.1.0

Version:

$Revision$ $Date$

Constructor Summary

Constructors

Constructor	Description
AbstractPortalEvent()

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.
protected void	setEventGroups(java.util.Set<java.lang.String> eventGroups)	Sets the groups for this event.
protected void	setOperationType(PortalEventOperationType operationType)	Sets the type of operation that generated this event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface lumis.portal.event.IPortalEvent

toString

Constructor Detail

AbstractPortalEvent

public AbstractPortalEvent()

Method Detail

getEventGroups

public java.util.Set<java.lang.String> getEventGroups()

Description copied from interface: IPortalEvent

Returns the event group identifiers for which this event was raised. The possible groups for each event may be defined by each event implementation.

Specified by:

getEventGroups in interface IPortalEvent

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.

setEventGroups

protected void setEventGroups(java.util.Set<java.lang.String> eventGroups)

Sets the groups for this event.

Parameters:

eventGroups - the groups to set.

Since:

4.1.0

getOperationType

public PortalEventOperationType getOperationType()

Description copied from interface: IPortalEvent

Returns the type of operation that generated this event.

Specified by:

getOperationType in interface IPortalEvent

Returns:

the type of operation that generated this event.

setOperationType

protected void setOperationType(PortalEventOperationType operationType)

Sets the type of operation that generated this event.

Parameters:

operationType - the operation type value to set.

Since:

4.1.0