com.atlassian.jira.issue.search
Interface SearchParameter

All Known Subinterfaces:

CustomFieldParameter, LuceneParameter

All Known Implementing Classes:

AbsoluteDateRangeParameter, AbstractLuceneParameter, AbstractSearchParameter, AbstractVersionParameter, AssigneeParameter, AssigneeParameter.Unassigned, ComponentParameter, DateParameter, FilterParameter, FixForParameter, FixForParameter.NoVersion, FreeTextParameter, GenericMultiValueParameter, HistorySearchParameter, IssueConstantsParameter, IssueTypeParameter, LongListParameter, MultipleFieldSingleValueLuceneParameter, NumberParameter, OfbizParameter, PermissionsParameter, PermissionsParameter, PriorityParameter, ProjectParameter, RelativeDateRangeParameter, ResolutionParameter, SingleFieldMultiValueLuceneParameter, SingleFieldSingleValueLuceneParameter, StatusParameter, StringListParameter, StringParameter, StringRangeParameter, SubTaskParentIssueParameter, UserParameter, UsersGroupParameter, VersionParameter, WorkRatioParameter

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) Adds a given value to the list of values
String	getName() Get issue field name.
String	getQueryString() Returns the query string
List	getValues() Returns a list of values
electric.xml.Element	getXml() Return an XML elemnt representation of this search parameter.
boolean	isValid() Returns true if this parameter is valid, false otherwise.
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

void addValue(Object value)

Adds a given value to the list of values

Parameters:

value - value to add

getValues

List getValues()

Returns a list of values

Returns:

list of values

getName

String getName()

Get issue field name.

Returns:

issue field name

setName

void setName(String fieldname)

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

Parameters:

fieldname - field name

getXml

electric.xml.Element getXml()

Return an XML elemnt representation of this search parameter.

Returns:

XML element

setXml

void setXml(electric.xml.Element el)

Initialise this search parameter using an XML element.

Usual process is:

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

Parameters:

el - XML element

isValid

boolean isValid()

Returns true if this parameter is valid, false otherwise.

Returns:

true if valid, false otherwise

getQueryString

String getQueryString()

Returns the query string

Returns:

query string