public class

SearchPerformedEvent

extends SearchEvent
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

Class Overview

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.

Summary

[Expand]
Inherited Fields
From class java.util.EventObject
Public Constructors
SearchPerformedEvent(Object source, SearchQueryBean query, User user, int numberOfResults)
This constructor is 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)
Public Methods
int getNumberOfResults()
SearchQueryBean getQuery()
This method is deprecated. since 2.9 (will always return null)
SearchQuery getSearchQuery()
User getUser()
[Expand]
Inherited Methods
From class com.atlassian.event.Event
From class org.springframework.context.ApplicationEvent
From class java.util.EventObject
From class java.lang.Object

Public Constructors

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

This constructor is 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

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

Public Methods

public int getNumberOfResults ()

public SearchQueryBean getQuery ()

This method is deprecated.
since 2.9 (will always return null)

public SearchQuery getSearchQuery ()

public User getUser ()