com.xpn.xwiki.plugin.globalsearch.tools
Class GlobalSearchQuery

java.lang.Object
  com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

public class GlobalSearchQuery
extends java.lang.Object

Contains all parameters for a global search query.

Version:

$Id$

Constructor Summary

GlobalSearchQuery()

Method Summary

void	addParameter(java.lang.Object value)
void	addParameterList(java.util.Collection<?> values)
void	addWikiName(java.lang.String wikiName)
void	addWikiNameList(java.util.Collection<java.lang.String> wikiNameList)
java.lang.String	getHql()
int	getMax()
java.util.List<java.lang.Object>	getParameterList()
int	getStart()
java.util.Collection<java.lang.String>	getWikiNameList()
void	setHql(java.lang.String hql)
void	setMax(int max)
void	setParameterList(java.util.Collection<?> values)
void	setStart(int start)
void	setWikiNameList(java.util.Collection<java.lang.String> wikiNameList)

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalSearchQuery

public GlobalSearchQuery()

Method Detail

addWikiNameList

public void addWikiNameList(java.util.Collection<java.lang.String> wikiNameList)

Parameters:

wikiNameList - names of wikis where to search.

setWikiNameList

public void setWikiNameList(java.util.Collection<java.lang.String> wikiNameList)

Parameters:

wikiNameList - the names of wikis where to search.

addWikiName

public void addWikiName(java.lang.String wikiName)

Parameters:

wikiName - a name of wiki where to search.

getWikiNameList

public java.util.Collection<java.lang.String> getWikiNameList()

Returns:

the names of wikis where to search.

setHql

public void setHql(java.lang.String hql)

Parameters:

hql - the hql query.

getHql

public java.lang.String getHql()

Returns:

the hql query.

addParameterList

public void addParameterList(java.util.Collection<?> values)

Parameters:

values - values to insert in the named query.

setParameterList

public void setParameterList(java.util.Collection<?> values)

Parameters:

values - the values to insert in the named query.

addParameter

public void addParameter(java.lang.Object value)

Parameters:

value - a value to insert in the named query.

getParameterList

public java.util.List<java.lang.Object> getParameterList()

Returns:

the values to insert in the named query.

setMax

public void setMax(int max)

Parameters:

max - the maximum number of results.

getMax

public int getMax()

Returns:

the maximum number of results.

setStart

public void setStart(int start)

Parameters:

start - the index of the first result.

getStart

public int getStart()

Returns:

the index of the first result.