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:

java.io.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(java.lang.Object source, SearchQueryBean query, com.atlassian.user.User user, int numberOfResults)
Create a new search performed event

Method Summary

int	getNumberOfResults()
SearchQueryBean	getQuery()
com.atlassian.user.User	getUser()

Methods inherited from class com.atlassian.confluence.event.events.ConfluenceEvent

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

public SearchPerformedEvent(java.lang.Object source,
                            SearchQueryBean query,
                            com.atlassian.user.User user,
                            int numberOfResults)

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

Method Detail

getQuery

public SearchQueryBean getQuery()

getUser

public com.atlassian.user.User getUser()

getNumberOfResults

public int getNumberOfResults()