org.obe.spi.service
Interface ApplicationEventBroker.EventSubscription

All Known Subinterfaces:
ApplicationEventBroker.ApplicationEventSubscription, ApplicationEventBroker.TemporalEventSubscription
Enclosing interface:
ApplicationEventBroker

public static interface ApplicationEventBroker.EventSubscription

Describes an event subscription.


Method Summary
 void cancel()
          Cancels the event subscription.
 int decrementCount()
          Decrements the remaining event count.
 java.lang.String[] getCorrelationKeys()
          Returns the correlation keys supplied when the subscription was created.
 int getCount()
          Returns the number of such events to deliver.
 java.util.Date getEffective()
          Returns the date at which the subscription commences.
 java.lang.String getEventType()
          Returns the event type for which the caller is subscribing.
 java.util.Date getExpiry()
          Returns the date at which the subscription expires.
 

Method Detail

getEventType

public java.lang.String getEventType()
Returns the event type for which the caller is subscribing.

Returns:
Event type.

getCorrelationKeys

public java.lang.String[] getCorrelationKeys()
Returns the correlation keys supplied when the subscription was created. The correlation keys are used to route the event to the process definition, process instance, activity instance, transition, etc., which is waiting for the specified event.

Returns:
Caller's correlation keys.

getEffective

public java.util.Date getEffective()
Returns the date at which the subscription commences. The system will not fulfil the subscription before this time. If null the subscription will is effective immediately.

Returns:
The effective date.

getExpiry

public java.util.Date getExpiry()
Returns the date at which the subscription expires. The system will not store or honour the subscription after that time. If null, the subscription will be canceled as soon as it has been fulfilled by a matching event.

Returns:
The expiry date.

getCount

public int getCount()
Returns the number of such events to deliver. The subscription automatically expires when the last event has been delivered.

Returns:
The event count.

decrementCount

public int decrementCount()
Decrements the remaining event count. When the count reaches 0 the subscription is automatically deleted. Infinitely recurring subscriptions always return -1.

Returns:
The new count (or -1).

cancel

public void cancel()
Cancels the event subscription. No further access to the subscription is permitted after it has been cancelled.



SourceForge.net Logo OBE-1.0 Copyright (c) 2002-2006 Adrian Price. All Rights Reserved.