com.atlassian.confluence.event.events.search
Class SearchPerformedEvent

java.lang.Object
  java.util.EventObject
      org.springframework.context.ApplicationEvent
          com.atlassian.event.Event
              com.atlassian.confluence.event.events.ConfluenceEvent
                  com.atlassian.confluence.event.events.search.SearchEvent
                      com.atlassian.confluence.event.events.search.SearchPerformedEvent

All Implemented Interfaces:

Serializable

public class SearchPerformedEvent
extends SearchEvent

Event triggered whenever a user performs a search through the search screen or the remote API. It is not triggered by the search macro, or by Lucene-backed queries that are not searches like the dashboard or RSS feeds.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

SearchPerformedEvent(Object source, SearchQueryBean query, User user, int numberOfResults)
Deprecated. since 2.9 the SearchQueryBean is no longer used (it will be null). Use SearchPerformedEvent(Object, SearchQuery, User, int) instead.

SearchPerformedEvent(Object source, SearchQuery query, User user, int numberOfResults)

Method Summary

int	getNumberOfResults()
SearchQueryBean	getQuery() Deprecated. since 2.9 (will always return null)
SearchQuery	getSearchQuery()
User	getUser()

Methods inherited from class com.atlassian.event.Event

equals, hashCode

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchPerformedEvent

@Deprecated
public SearchPerformedEvent(Object source,
                                       SearchQueryBean query,
                                       User user,
                                       int numberOfResults)

Deprecated. since 2.9 the SearchQueryBean is no longer used (it will be null). Use SearchPerformedEvent(Object, SearchQuery, User, int) instead.

Create a new search performed event

Parameters:

source - the source of the event

query - the query that was performed

user - the user who performed the search (may be null if the query was performed anonymously)

numberOfResults - the number of results returned by the search

SearchPerformedEvent

public SearchPerformedEvent(Object source,
                            SearchQuery query,
                            User user,
                            int numberOfResults)

Method Detail

getQuery

@Deprecated
public SearchQueryBean getQuery()

Deprecated. since 2.9 (will always return null)

getSearchQuery

public SearchQuery getSearchQuery()

getUser

public User getUser()

getNumberOfResults

public int getNumberOfResults()