com.atlassian.jira.issue.search
Interface SearchParameter

All Known Subinterfaces:

CustomFieldParameter

All Known Implementing Classes:

AbstractSearchParameter, CustomFieldDateParameter, CustomFieldNumberParameter, CustomFieldObjectParameter, CustomFieldPeriodParameter, CustomFieldSelectParameter, CustomFieldStringParameter

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(java.lang.Object value)
java.lang.String	getName()
java.lang.String	getQueryString()
java.util.List	getValues()
Element	getXml() Return an XML representation of this search parameter
boolean	isValid()
void	setName(java.lang.String fieldname)
void	setXml(Element el) Initialise this search parameter using an XML element.

Method Detail

addValue

public void addValue(java.lang.Object value)

getValues

public java.util.List getValues()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String fieldname)

getXml

public Element getXml()

Return an XML representation of this search parameter

setXml

public void setXml(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 java.lang.String getQueryString()