public class

SearchSiteAction

extends ConfluenceActionSupport
implements Beanable
java.lang.Object
   ↳ com.opensymphony.xwork.ActionSupport
     ↳ com.atlassian.confluence.core.ConfluenceActionSupport
       ↳ com.atlassian.confluence.search.actions.SearchSiteAction

Summary

Nested Classes
class SearchSiteAction.BackwardsCompatibility A class used to preserve compatibility with old style search URL's where search parameters were entered in the format: searchQuery.spaceKey=conf_all&searchQuery.queryString=hello. 
class SearchSiteAction.CriteriaParameters A Class used to represent the different criteria restriction links that are displayed along with the search results. 
class SearchSiteAction.UserDetails  
[Expand]
Inherited Constants
From class com.atlassian.confluence.core.ConfluenceActionSupport
From interface com.opensymphony.xwork.Action
[Expand]
Inherited Fields
From class com.atlassian.confluence.core.ConfluenceActionSupport
From class com.opensymphony.xwork.ActionSupport
Public Constructors
SearchSiteAction()
Public Methods
String execute()
List getAggregateOptions()
List getAvailableGlobalSpaces()
Find all global spaces that user has permission to view, but that aren't favourites
Object getBean()
List<PairType> getContentEntityTypes()
This method is deprecated. duplicate of getTypeOptions()
List getContentLabels(ContentEntityObject content, int amount)
ContentTypeEnum getContentType()
ContentTypesDisplayMapper getContentTypesDisplayMapper()
String getContributor()
String getContributorUsername()
SearchSiteAction.CriteriaParameters getCurrentSearch()
List<PairType> getDateRanges()
String getDecoratedQuerySuggestion()
int getEndIndex()
List getFavouriteSpaces()
String getKey()
String getLabelNames(Labelable obj)
Retrieve a comma separated string of label names.
Summary getLabelsSummaryForResult(SearchResult result)
DateRangeEnum getLastModified()
PaginationSupport getPaginationSupport()
String getPlainQuerySuggestion()
String getQueryString()
List<Label> getRelatedLabels()
Returns a list of related labels to the labels matching the search result
List<SearchResult> getResults()
SearchSiteAction.BackwardsCompatibility getSearchQuery()
List<String> getSearchWords()
Space getSpace(String spaceKey)
int getStartIndex()
String getSummaryForResult(SearchResult result)
Timer getTimer()
String getTitleForResult(SearchResult result)
int getTotalSearchResults()
String getType()
String getTypeName(String type)
List<PairType> getTypeOptions()
WebInterfaceContext getWebInterfaceContext(SearchResult result)
String getWhere()
String newSearchResult(SearchResult searchResult, String showExcerpts, String queryString)
void setContentTypesDisplayMapper(ContentTypesDisplayMapper contentTypesDisplayMapper)
void setContributor(String who)
void setContributorUsername(String contributorUsername)
void setDelegatedSearchResultRenderer(DelegatedSearchResultRenderer defaultRenderer)
void setKey(String key)
void setLastModified(DateRangeEnum lastModified)
void setPluginAccessor(PluginAccessor pluginAccessor)
void setPredefinedSearchBuilder(PredefinedSearchBuilder predefinedSearchBuilder)
void setQueryAnalyzer(Analyzer queryAnalyzer)
void setQueryString(String queryString)
void setQuerySuggester(QuerySuggester querySuggester)
void setSearchManager(SearchManager searchManager)
void setSearchMapper(LuceneSearchMapper searchMapper)
void setSpaceManager(SpaceManager spaceManager)
void setStartIndex(int startIndex)
void setType(String type)
void setTypes(String[] types)
void setUserAccessor(UserAccessor userAccessor)
void setWhere(String where)
void validate()
[Expand]
Inherited Methods
From class com.atlassian.confluence.core.ConfluenceActionSupport
From class com.opensymphony.xwork.ActionSupport
From class java.lang.Object
From interface com.atlassian.confluence.core.Beanable
From interface com.atlassian.confluence.plugin.descriptor.web.WebInterface
From interface com.opensymphony.xwork.Action
From interface com.opensymphony.xwork.LocaleProvider
From interface com.opensymphony.xwork.TextProvider
From interface com.opensymphony.xwork.Validateable
From interface com.opensymphony.xwork.ValidationAware

Public Constructors

public SearchSiteAction ()

Public Methods

public String execute ()

Throws
Exception

public List getAggregateOptions ()

public List getAvailableGlobalSpaces ()

Find all global spaces that user has permission to view, but that aren't favourites

Returns
  • List

public Object getBean ()

public List<PairType> getContentEntityTypes ()

This method is deprecated.
duplicate of getTypeOptions()

public List getContentLabels (ContentEntityObject content, int amount)

public ContentTypeEnum getContentType ()

public ContentTypesDisplayMapper getContentTypesDisplayMapper ()

public String getContributor ()

public String getContributorUsername ()

public SearchSiteAction.CriteriaParameters getCurrentSearch ()

Returns
  • a criteria link that represents the current search state

public List<PairType> getDateRanges ()

Returns
  • a list of the date range criteria that should be presented on the GUI.

public String getDecoratedQuerySuggestion ()

public int getEndIndex ()

public List getFavouriteSpaces ()

public String getKey ()

public String getLabelNames (Labelable obj)

Retrieve a comma separated string of label names.

Returns
  • a comma separated string

public Summary getLabelsSummaryForResult (SearchResult result)

public DateRangeEnum getLastModified ()

public PaginationSupport getPaginationSupport ()

public String getPlainQuerySuggestion ()

public String getQueryString ()

public List<Label> getRelatedLabels ()

Returns a list of related labels to the labels matching the search result

Returns
  • List of related lables

public List<SearchResult> getResults ()

public SearchSiteAction.BackwardsCompatibility getSearchQuery ()

public List<String> getSearchWords ()

public Space getSpace (String spaceKey)

public int getStartIndex ()

public String getSummaryForResult (SearchResult result)

public Timer getTimer ()

public String getTitleForResult (SearchResult result)

public int getTotalSearchResults ()

public String getType ()

public String getTypeName (String type)

public List<PairType> getTypeOptions ()

Returns
  • a list of the type criteria that should be presented on the GUI.

public WebInterfaceContext getWebInterfaceContext (SearchResult result)

public String getWhere ()

public String newSearchResult (SearchResult searchResult, String showExcerpts, String queryString)

public void setContentTypesDisplayMapper (ContentTypesDisplayMapper contentTypesDisplayMapper)

public void setContributor (String who)

public void setContributorUsername (String contributorUsername)

public void setDelegatedSearchResultRenderer (DelegatedSearchResultRenderer defaultRenderer)

Parameters
defaultRenderer the defaultRenderer to set

public void setKey (String key)

public void setLastModified (DateRangeEnum lastModified)

public void setPluginAccessor (PluginAccessor pluginAccessor)

public void setPredefinedSearchBuilder (PredefinedSearchBuilder predefinedSearchBuilder)

public void setQueryAnalyzer (Analyzer queryAnalyzer)

public void setQueryString (String queryString)

public void setQuerySuggester (QuerySuggester querySuggester)

public void setSearchManager (SearchManager searchManager)

public void setSearchMapper (LuceneSearchMapper searchMapper)

public void setSpaceManager (SpaceManager spaceManager)

public void setStartIndex (int startIndex)

public void setType (String type)

public void setTypes (String[] types)

public void setUserAccessor (UserAccessor userAccessor)

public void setWhere (String where)

public void validate ()