com.atlassian.jira.issue.search.parameters.lucene
Class UsersGroupParameter

java.lang.Object
  com.atlassian.jira.issue.search.parameters.lucene.UsersGroupParameter

All Implemented Interfaces:

LuceneParameter, SearchParameter

public class UsersGroupParameter

extends Object

implements LuceneParameter

Constructor Summary

UsersGroupParameter()

UsersGroupParameter(String name, String userLuceneFieldName, String groupName)

Method Summary

void	addValue(Object value)
String	getName() Get issue field name.
org.apache.lucene.search.Query	getQuery(org.ofbiz.core.entity.GenericValue project, User searcher)
String	getQueryString()
List	getValues()
electric.xml.Element	getXml() Return an XML representation of this search parameter.
boolean	isValid()
void	setName(String fieldname) Specify issue field name to limit search by.
void	setXml(electric.xml.Element el) Initialise this search parameter using an XML element.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersGroupParameter

public UsersGroupParameter()

UsersGroupParameter

public UsersGroupParameter(String name,
                           String userLuceneFieldName,
                           String groupName)

Method Detail

addValue

public void addValue(Object value)

Specified by:

addValue in interface SearchParameter

getValues

public List getValues()

Specified by:

getValues in interface SearchParameter

getName

public String getName()

Description copied from interface: SearchParameter

Get issue field name.

Specified by:

getName in interface SearchParameter

setName

public void setName(String fieldname)

Description copied from interface: SearchParameter

Specify issue field name to limit search by. Either a predefined name (from IssueFieldConstants, or Field.getId().

Specified by:

setName in interface SearchParameter

getXml

public electric.xml.Element getXml()

Description copied from interface: SearchParameter

Return an XML representation of this search parameter.

Specified by:

getXml in interface SearchParameter

setXml

public void setXml(electric.xml.Element el)

Description copied from interface: SearchParameter

Initialise this search parameter using an XML element. Usual process is:

    SearchParameter param = new MySearchParameter();
    param.setXml(element);
 

Specified by:

setXml in interface SearchParameter

isValid

public boolean isValid()

Specified by:

isValid in interface SearchParameter

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface SearchParameter

getQuery

public org.apache.lucene.search.Query getQuery(org.ofbiz.core.entity.GenericValue project,
                                               User searcher)
                                        throws org.apache.lucene.queryParser.ParseException

Specified by:

getQuery in interface LuceneParameter

Returns:

a collection of Query objects.

Throws:

org.apache.lucene.queryParser.ParseException