com.atlassian.jira.issue.search
Interface SearchParameter

All Known Subinterfaces:

CustomFieldParameter, LuceneParameter

All Known Implementing Classes:

AbstractLuceneParameter, AbstractSearchParameter, UsersGroupParameter

public interface SearchParameter

A SearchParameter restricts searches for issues. All SearchParameters must have a blank constructor, and can be created in two ways:

1. by using their individual constructors
2. by using the blank constructor and then calling setXml(element) to initialise the parameter

See Also:

SearchRequest

Method Summary

void	addValue(Object value)
String	getName() Get issue field name.
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.

Method Detail

addValue

public void addValue(Object value)

getValues

public List getValues()

getName

public String getName()

Get issue field name.

setName

public void setName(String fieldname)

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

getXml

public electric.xml.Element getXml()

Return an XML representation of this search parameter.

setXml

public void setXml(electric.xml.Element el)

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

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

isValid

public boolean isValid()

getQueryString

public String getQueryString()