com.sapportals.wcm.util.events

Interface IEventReceiverBulk

All Superinterfaces:

IEventReceiver

All Known Subinterfaces:

IResourceEventReceiverBulk

public interface IEventReceiverBulk
extends IEventReceiver

Defines an asynchronous event receiver that is able to handle bulks of resource events. If this receiver is registered for asynchronous events the receive() method for single events (IEventReceiver.received(IEvent)) is never called. If this is registered for synchronous events however, only the method for single events will be called.

Method Summary

int	getMaxNumberOfEvents() Returns the maximum number of events to receive in a single call of the received(IEvent[]) method (that is the max. size of the event array).
int	getWaitTime() Returns the amount of time in milliseconds to wait for the max. number getMaxNumberOfEvents() of events to be reached.
void	received(IEvent[] events) This method will be called by the event broker with an array of events.

Methods inherited from interface com.sapportals.wcm.util.events.IEventReceiver

received

Method Detail

getMaxNumberOfEvents

int getMaxNumberOfEvents()

Returns the maximum number of events to receive in a single call of the received(IEvent[]) method (that is the max. size of the event array). The returned number must be > 1.

Returns:

the maximum number of events to receive in a single call of the received(IEvent[]) method.

getWaitTime

int getWaitTime()

Returns the amount of time in milliseconds to wait for the max. number getMaxNumberOfEvents() of events to be reached. The returned number should be > 1000.

Returns:

the amount of time in milliseconds to wait for the max. number getMaxNumberOfEvents() of events to be reached.

received

void received(IEvent[] events)

This method will be called by the event broker with an array of events. The size of the array can be smaller than the MaxNumberOfEvents value if the WaitTime has elapsed before the number of queued events has reached MaxNumberOfEvents. But the size of the array will always be > 0 (if the queue is empty after the WaitTime has elapsed this mehtod is not called).

Parameters:

events -

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM