public class

ResultTemplate

extends Object
java.lang.Object
   ↳ com.atlassian.confluence.search.contentnames.ResultTemplate

Class Overview

Class that allows clients to specify what categories of results to get back from any content name search. A default configuration is available through DEFAULT. To produce a custom configuration, use addCategory(Category, int) .

Summary

Fields
public static final ResultTemplate DEFAULT A default category configuration.
Public Constructors
ResultTemplate()
Public Methods
void addCategory(Category category, int maxResultCount)
Add a category.
boolean equals(Object o)
Set<Category> getCategories()
Returns the names of all categories defined in this configuration.
int getMaxResultCount(Category category)
The maximum number of results for this category.
int getMaximumResults()
int getNumberOfCategories()
Returns the number of categories defined in this configuration.
boolean hasCategory(Category category)
Returns true if the specified category is defined, false otherwise.
int hashCode()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public static final ResultTemplate DEFAULT

A default category configuration.

Public Constructors

public ResultTemplate ()

Public Methods

public void addCategory (Category category, int maxResultCount)

Add a category.

Parameters
category name of category
maxResultCount the maximum number of results for the specified category

public boolean equals (Object o)

public Set<Category> getCategories ()

Returns the names of all categories defined in this configuration.

Returns
  • the names of all categories defined in this configuration.

public int getMaxResultCount (Category category)

The maximum number of results for this category. If the specified category is not defined, then 0 is returned.

Parameters
category name of category
Returns
  • the maximum number of results for the specified category.

public int getMaximumResults ()

Returns
  • based on the categories and numbers of results specified for each, return the maximum number of results this template specifies

public int getNumberOfCategories ()

Returns the number of categories defined in this configuration.

Returns
  • the number of categories defined in this configuration.

public boolean hasCategory (Category category)

Returns true if the specified category is defined, false otherwise.

Parameters
category name of category
Returns
  • true if the specified category is defined, false otherwise.

public int hashCode ()