com.atlassian.confluence.search.actions
Class ContentNameSearchAction.ContentNameSearchResult

java.lang.Object
  com.atlassian.confluence.search.actions.ContentNameSearchAction.ContentNameSearchResult

Enclosing class:

ContentNameSearchAction

public static class ContentNameSearchAction.ContentNameSearchResult
extends java.lang.Object

The result from performing a ContentNameSearch.

Constructor Summary

ContentNameSearchAction.ContentNameSearchResult(java.lang.String query)

Method Summary

java.util.List<java.util.List<ContentNameSearchAction.ContentNameMatch>>	getContentNameMatches() Each sub-list within the returned list will have results of the same 'category'.
java.lang.String	getQuery()
java.util.List<java.lang.String>	getQueryTokens() The individual tokens from the query String that these results are for.
java.lang.String	getStatusMessage() A message indicating information about the search.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ContentNameSearchAction.ContentNameSearchResult

public ContentNameSearchAction.ContentNameSearchResult(java.lang.String query)

Method Detail

getQueryTokens

public java.util.List<java.lang.String> getQueryTokens()

The individual tokens from the query String that these results are for. You might use these tokens to highlight matches in the results when displaying them.

Returns:

the individual tokens from the query String.

getStatusMessage

public java.lang.String getStatusMessage()

A message indicating information about the search. For example, if there were no results then this is explicitly stated by this status message. A client can assume that if there is a statusMessage then they should not expect any contentNameMatches.

Returns:

a status message or null if there are no explicit messages.

getContentNameMatches

public java.util.List<java.util.List<ContentNameSearchAction.ContentNameMatch>> getContentNameMatches()

Each sub-list within the returned list will have results of the same 'category'. The ordering of the className groupings within the top level list is defined by the default ResultTemplate.

Returns:

a List of Lists of ContentNameMatch

See Also:

ResultTemplate.DEFAULT

getQuery

public java.lang.String getQuery()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object