SearchResultsPage (Apache JSPWiki 2.12.2 API)

java.lang.Object
- org.apache.wiki.pages.haddock.SearchResultsPage

All Implemented Interfaces:

HaddockPage, Page
```
public class SearchResultsPage
extends java.lang.Object
implements HaddockPage
```
Actions available on the Search Results page.

Constructor Summary

Constructors
Constructor Description

SearchResultsPage()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ViewWikiPage`	`navigateTo(java.lang.String result)`	Navigates to a view page from the search results.
`static SearchResultsPage`	`open(java.lang.String pageName)`	Open the search results page with a given query text to search for.
`java.util.List<java.lang.String>`	`pagesFound()`	Returns the search result page names.
`SearchResultsPage`	`shouldContain(java.lang.String... pageNames)`	Ensures that the given page names are present on the search results.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.wiki.pages.haddock.HaddockPage
wikiPageContent, wikiTitle

Methods inherited from interface org.apache.wiki.pages.Page
title, url

- Constructor Detail
  - SearchResultsPage
```
public SearchResultsPage()
```
- Method Detail
  - open
```
public static SearchResultsPage open(java.lang.String pageName)
```
    Open the search results page with a given query text to search for.
    
    Parameters:
    
    pageName - Wiki page name to View.
    
    Returns:
    
    ViewWikiPage instance, to allow chaining of actions.
  - pagesFound
```
public java.util.List<java.lang.String> pagesFound()
```
    Returns the search result page names.
    
    Returns:
    
    the list of page names returned by the search query.
  - shouldContain
```
public SearchResultsPage shouldContain(java.lang.String... pageNames)
```
    Ensures that the given page names are present on the search results.
    
    Parameters:
    
    pageNames - page names to look for.
    
    Returns:
    
    SearchResultsPage instance, to allow chaining of actions.
  - navigateTo
```
public ViewWikiPage navigateTo(java.lang.String result)
```
    Navigates to a view page from the search results.
    
    Parameters:
    
    result - wikipage name to navigate to.
    
    Returns:
    
    ViewWikiPage instance, to allow chaining of actions.