Nuxeo ECM Projects 5.4.3-SNAPSHOT

org.nuxeo.ecm.core.listener
Interface EventListener

All Known Subinterfaces:
AsynchronousEventListener, SynchronousEventListener
All Known Implementing Classes:
AbstractEventListener, NXRuntimeEventListener, TestTransactedListener

public interface EventListener

EventListener interface.

Author:
Julien Anguenot

Method Summary
 boolean accepts(String eventId)
          Returns true if listener processes given event id.
 void addEventId(String eventId)
          Adds an event id for this listener to process.
 String getName()
          Returns the name of the event listener.
 Integer getOrder()
          Returns the int order of the event listener.
 void handleEvent(CoreEvent coreEvent)
          Handles the given event.
 void operationStarted(Operation<?> cmd)
           
 void operationTerminated(Operation<?> cmd)
           
 void removeEventId(String eventId)
          Removes an event id for this listener to process.
 void setName(String name)
          Sets the name of the event listener.
 void setOrder(Integer order)
          Sets the int order of the event listener.
 

Method Detail

getName

String getName()
Returns the name of the event listener.

Returns:
the name of the event listener

setName

void setName(String name)
Sets the name of the event listener.

Parameters:
name - of the event listener

getOrder

Integer getOrder()
Returns the int order of the event listener.

Returns:
the int order of the event listener.

setOrder

void setOrder(Integer order)
Sets the int order of the event listener.

Parameters:
order - the Integer order of the event listener.

addEventId

void addEventId(String eventId)
Adds an event id for this listener to process.


removeEventId

void removeEventId(String eventId)
Removes an event id for this listener to process.


accepts

boolean accepts(String eventId)
Returns true if listener processes given event id.

If no event ids are set for this listener, returns true.


handleEvent

void handleEvent(CoreEvent coreEvent)
                 throws Exception
Handles the given event.

Parameters:
coreEvent -
Throws:
Exception

operationStarted

void operationStarted(Operation<?> cmd)
                      throws Exception
Throws:
Exception

operationTerminated

void operationTerminated(Operation<?> cmd)
                         throws Exception
Throws:
Exception

Nuxeo ECM Projects 5.4.3-SNAPSHOT

Copyright © 2011 Nuxeo SAS. All Rights Reserved.