Clearspace API (2.5.29) Core Javadocs

com.jivesoftware.community.event
Class SearchIndexEvent

java.lang.Object
  extended by com.jivesoftware.community.event.SearchIndexEvent
All Implemented Interfaces:
com.jivesoftware.community.JiveEvent

public class SearchIndexEvent
extends Object
implements com.jivesoftware.community.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 COMMENT_ADDED
          Event type for whenever a comment is added to the search index
static int COMMENT_DELETED
          Event type for whenever a comment is removed to 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 PROJECT_ADDED
          Event type for whenever a project is added to the search index
static int PROJECT_DELETED
          Event type for whenever a project is removed to the search index
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 SOCIAL_GROUP_ADDED
          Event type for whenever a social group is added
static int SOCIAL_GROUP_REMOVED
          Event type for whenever a social group is deleted
static int TASK_ADDED
          Event type for whenever a task is added to the search index
static int TASK_DELETED
          Event type for whenever a task is removed to the search index
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, Map<String,? extends Object> params)
           
 
Method Summary
 Date getDate()
           
 int getEventType()
           
 Map<String,? extends Object> getParams()
           
 
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

PROJECT_ADDED

public static final int PROJECT_ADDED
Event type for whenever a project is added to the search index

See Also:
Constant Field Values

PROJECT_DELETED

public static final int PROJECT_DELETED
Event type for whenever a project is removed to the search index

See Also:
Constant Field Values

TASK_ADDED

public static final int TASK_ADDED
Event type for whenever a task is added to the search index

See Also:
Constant Field Values

TASK_DELETED

public static final int TASK_DELETED
Event type for whenever a task is removed to the search index

See Also:
Constant Field Values

COMMENT_ADDED

public static final int COMMENT_ADDED
Event type for whenever a comment is added to the search index

See Also:
Constant Field Values

COMMENT_DELETED

public static final int COMMENT_DELETED
Event type for whenever a comment is removed to the search index

See Also:
Constant Field Values

SOCIAL_GROUP_ADDED

public static final int SOCIAL_GROUP_ADDED
Event type for whenever a social group is added

See Also:
Constant Field Values

SOCIAL_GROUP_REMOVED

public static final int SOCIAL_GROUP_REMOVED
Event type for whenever a social group is deleted

See Also:
Constant Field Values
Constructor Detail

SearchIndexEvent

public SearchIndexEvent(int eventType,
                        Map<String,? extends Object> params)
Method Detail

getEventType

public int getEventType()
Specified by:
getEventType in interface com.jivesoftware.community.JiveEvent

getParams

public Map<String,? extends Object> getParams()
Specified by:
getParams in interface com.jivesoftware.community.JiveEvent

getDate

public Date getDate()
Specified by:
getDate in interface com.jivesoftware.community.JiveEvent

Clearspace Project Page

Copyright © 1999-2007 Jive Software.