com.sapportals.wcm.util.events

Interface IEvent

All Known Subinterfaces:

IDiscussionEvent, IIndexServiceEvent, IResourceEvent, IStatemanagementEvent, ISubscriptionConditionEvent, ITimebasedPublishEvent

All Known Implementing Classes:

DiscussionEvent, DiscussionEvent, IndexServiceEvent, ResourceEvent, StatemanagementEvent, TimebasedPublishEvent

public interface IEvent

This interface defines an event with a type and an arbitrary parameter.

Copyright (c) SAP AG 2001-2002

Method Summary

String	getDescription()
String	getDescription(Locale locale)
Object	getParameter() Returns the event's parameter
int	getType() Returns the event's type
boolean	isLike(IEvent template) Compares this event with another event for equality or some kind of "similarity".

Method Detail

getType

public int getType()

Returns the event's type

Returns:

the event's type

getParameter

public Object getParameter()

Returns the event's parameter

Returns:

the event's parameter

isLike

public boolean isLike(IEvent template)

Compares this event with another event for equality or some kind of "similarity". Normally an event equals another if it is of the same instance and type. There might be implementations that want to match one event type with many others.

Parameters:

template - The other event to compare with.

Returns:

True, if the specified event template is equal to this event, according to the implemented matching rules.

getDescription

public String getDescription()

getDescription

public String getDescription(Locale locale)