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

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

public class GlobalSearchQuery
extends Object

Contains all parameters for a global search query.


Constructor Summary
GlobalSearchQuery()
           
 
Method Summary
 void addParameter(Object value)
           
 void addParameterList(Collection<?> values)
           
 void addWikiName(String wikiName)
           
 void addWikiNameList(Collection<String> wikiNameList)
           
 String getHql()
           
 int getMax()
           
 List<Object> getParameterList()
           
 int getStart()
           
 Collection<String> getWikiNameList()
           
 void setHql(String hql)
           
 void setMax(int max)
           
 void setParameterList(Collection<?> values)
           
 void setStart(int start)
           
 void setWikiNameList(Collection<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(Collection<String> wikiNameList)
Parameters:
wikiNameList - names of wikis where to search.

setWikiNameList

public void setWikiNameList(Collection<String> wikiNameList)
Parameters:
wikiNameList - the names of wikis where to search.

addWikiName

public void addWikiName(String wikiName)
Parameters:
wikiName - a name of wiki where to search.

getWikiNameList

public Collection<String> getWikiNameList()
Returns:
the names of wikis where to search.

setHql

public void setHql(String hql)
Parameters:
hql - the hql query.

getHql

public String getHql()
Returns:
the hql query.

addParameterList

public void addParameterList(Collection<?> values)
Parameters:
values - values to insert in the named query.

setParameterList

public void setParameterList(Collection<?> values)
Parameters:
values - the values to insert in the named query.

addParameter

public void addParameter(Object value)
Parameters:
value - a value to insert in the named query.

getParameterList

public List<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.