com.bigbross.bossa.history
Class HistoryListener

java.lang.Object
  com.bigbross.bossa.history.HistoryListener

All Implemented Interfaces:

Listener, Serializable

public class HistoryListener

extends Object

implements Listener, Serializable

This class implements the listener for a historian in the notification bus.

Author:

BigBross Team

See Also:

Serialized Form

Constructor Summary

HistoryListener(Historian historian)
Creates a new listener.

Method Summary

String	getId() Returns the id of this listener.
Resource	getResource() Returns the resource used to further filter the work item or activity related events passed to this listener.
boolean	interested(int type) Indicates if this listener is interested in an event type.
void	notifyEvent(Event event) Notifies this listener of an event.

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryListener

public HistoryListener(Historian historian)

Creates a new listener.

Parameters:

historian - the historian this listener is working to.

Method Detail

getId

public String getId()

Description copied from interface: Listener

Returns the id of this listener. This id must be unique with respect to the desired notification bus.

Specified by:

getId in interface Listener

Returns:

the id of this listener.

See Also:

Listener.getId()

interested

public boolean interested(int type)

Description copied from interface: Listener

Indicates if this listener is interested in an event type. The notification bus will only notify this listener of the event types it is interested.

Specified by:

interested in interface Listener

Parameters:

type - the type of the event.

Returns:

true if this listener is interested in the event, false otherwise.

See Also:

Listener.interested(int)

getResource

public Resource getResource()

Description copied from interface: Listener

Returns the resource used to further filter the work item or activity related events passed to this listener. The notification bus will only notify this listener of events associated with resources that contain the resource returned by this method. If the resource returned is null, no resource filtering will happen.

Specified by:

getResource in interface Listener

Returns:

the resource to be used as filter.

See Also:

Listener.getResource()

notifyEvent

public void notifyEvent(Event event)

Description copied from interface: Listener

Notifies this listener of an event. See the event class for the information provided to the listener.

Specified by:

notifyEvent in interface Listener

Parameters:

event - the event.

See Also:

Listener.notifyEvent( com.bigbross.bossa.notify.Event)