com.jivesoftware.community.event
Class SearchIndexEvent

java.lang.Object
  com.jivesoftware.community.event.SearchIndexEvent

All Implemented Interfaces:

JiveEvent

public class SearchIndexEvent
extends java.lang.Object
implements JiveEvent

A class for search index events. This class will be passed to SearchIndexListeners whenever an search index event is fired and contains all the pertinent information to the event.

Field Summary

static int	BLOG_ADDED Event type for whenever a blog is added to the search index.
static int	BLOG_POST_ADDED Event type for whenever a blog post is added to the search index.
static int	BLOG_POST_DELETED Event type for whenever a blog post is removed from the search index.
static int	COMMUNITY_ADDED Event type for whenever a community is added to the search index.
static int	DOCUMENT_ADDED Event type for whenever a document is added to the search index.
static int	DOCUMENT_DELETED Event type for whenever a document is removed from the search index.
static int	MESSAGE_ADDED Event type for whenever a message is added to the search index.
static int	MESSAGE_DELETED Event type for whenever a message is removed from the search index.
static int	OPTIMIZE_COMPLETED Event type for whenever an index optimize is completed.
static int	OPTIMIZE_STARTED Event type for whenever an index optimize is started.
static int	REBUILD_COMPLETED Event type for whenever an index rebuild is completed.
static int	REBUILD_STARTED Event type for whenever an index rebuild is started.
static int	UPDATE_COMPLETED Event type for whenever an index update is completed.
static int	UPDATE_STARTED Event type for whenever an index update is started.

Constructor Summary

SearchIndexEvent(int eventType, java.util.Map<java.lang.String,? extends java.lang.Object> params)

Method Summary

java.util.Date	getDate() Returns the date (as a Date object) that the event was created.
int	getEventType() Returns the event type corresponding to the event.
java.util.Map<java.lang.String,? extends java.lang.Object>	getParams() Returns a map of parameters which can be used to pass data to a listener.

Methods inherited from class java.lang.Object

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

Field Detail

BLOG_ADDED

public static final int BLOG_ADDED

Event type for whenever a blog is added to the search index.

See Also:

Constant Field Values

BLOG_POST_ADDED

public static final int BLOG_POST_ADDED

Event type for whenever a blog post is added to the search index.

See Also:

Constant Field Values

BLOG_POST_DELETED

public static final int BLOG_POST_DELETED

Event type for whenever a blog post is removed from the search index.

See Also:

Constant Field Values

MESSAGE_ADDED

public static final int MESSAGE_ADDED

Event type for whenever a message is added to the search index.

See Also:

Constant Field Values

MESSAGE_DELETED

public static final int MESSAGE_DELETED

Event type for whenever a message is removed from the search index.

See Also:

Constant Field Values

DOCUMENT_ADDED

public static final int DOCUMENT_ADDED

Event type for whenever a document is added to the search index.

See Also:

Constant Field Values

COMMUNITY_ADDED

public static final int COMMUNITY_ADDED

Event type for whenever a community is added to the search index.

See Also:

Constant Field Values

DOCUMENT_DELETED

public static final int DOCUMENT_DELETED

Event type for whenever a document is removed from the search index.

See Also:

Constant Field Values

REBUILD_STARTED

public static final int REBUILD_STARTED

Event type for whenever an index rebuild is started.

See Also:

Constant Field Values

REBUILD_COMPLETED

public static final int REBUILD_COMPLETED

Event type for whenever an index rebuild is completed.

See Also:

Constant Field Values

UPDATE_STARTED

public static final int UPDATE_STARTED

Event type for whenever an index update is started.

See Also:

Constant Field Values

UPDATE_COMPLETED

public static final int UPDATE_COMPLETED

Event type for whenever an index update is completed.

See Also:

Constant Field Values

OPTIMIZE_STARTED

public static final int OPTIMIZE_STARTED

Event type for whenever an index optimize is started.

See Also:

Constant Field Values

OPTIMIZE_COMPLETED

public static final int OPTIMIZE_COMPLETED

Event type for whenever an index optimize is completed.

See Also:

Constant Field Values

Constructor Detail

SearchIndexEvent

public SearchIndexEvent(int eventType,
                        java.util.Map<java.lang.String,? extends java.lang.Object> params)

Method Detail

getEventType

public int getEventType()

Description copied from interface: JiveEvent

Returns the event type corresponding to the event.

Specified by:

getEventType in interface JiveEvent

Returns:

the event type corresponding to the event.

getParams

public java.util.Map<java.lang.String,? extends java.lang.Object> getParams()

Description copied from interface: JiveEvent

Returns a map of parameters which can be used to pass data to a listener.

Specified by:

getParams in interface JiveEvent

Returns:

map of parameters which can be used to pass data to a listener.

getDate

public java.util.Date getDate()

Description copied from interface: JiveEvent

Returns the date (as a Date object) that the event was created.

Specified by:

getDate in interface JiveEvent

Returns:

the date (as a Date object) that the event was created.