Package org.intermine.api.search

Class TaggingEvent

java.lang.Object

org.intermine.api.search.OriginatingEvent

org.intermine.api.search.TaggingEvent

All Implemented Interfaces:

ChangeEvent

public class TaggingEvent
extends OriginatingEvent

A representation of a notification that a tag has been changed on a web-searchable item.

Author:

Alex Kalderimis.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TaggingEvent.TagChange	The possible actions that this event can represent.

Field Summary

Fields

Modifier and Type	Field	Description
protected TaggingEvent.TagChange	action
protected java.lang.String	tagName

Fields inherited from class org.intermine.api.search.OriginatingEvent

origin

Constructor Summary

Constructors

Constructor	Description
TaggingEvent(WebSearchable origin, java.lang.String tagName, TaggingEvent.TagChange action)	Constructor.

Method Summary

Modifier and Type	Method	Description
TaggingEvent.TagChange	getAction()
java.lang.String	getTagName()

Methods inherited from class org.intermine.api.search.OriginatingEvent

getOrigin

Methods inherited from class java.lang.Object

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

Field Detail

tagName

protected final java.lang.String tagName

action

protected final TaggingEvent.TagChange action

Constructor Detail

TaggingEvent

public TaggingEvent(WebSearchable origin,
                    java.lang.String tagName,
                    TaggingEvent.TagChange action)

Constructor.

Parameters:

origin - The item involved in the event.

tagName - The name of the tag involved.

action - Whethe the tag was added or removed.

Method Detail

getTagName

public java.lang.String getTagName()

Returns:

the name of the tag involved.

getAction

public TaggingEvent.TagChange getAction()

Returns:

the action this represents.