com.atlassian.jira.issue.search.constants

Class IssueKeyConstants

java.lang.Object

com.atlassian.jira.issue.search.constants.IssueKeyConstants

All Implemented Interfaces:

ClauseInformation

public class IssueKeyConstants
extends Object
implements ClauseInformation

Constants for issue key.

Since:

v4.0

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
JiraDataType	getDataType() Provides the JiraDataType that this clause handles and searches on.
String	getFieldId()
String	getIndexField()
static IssueKeyConstants	getInstance()
ClauseNames	getJqlClauseNames()
String	getKeyIndexOrderField()
Set<Operator>	getSupportedOperators() Provides a set of the supported Operator's that this custom field searcher can handle for its searching.
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Detail

getJqlClauseNames

public ClauseNames getJqlClauseNames()

Specified by:

getJqlClauseNames in interface ClauseInformation

Returns:

the allowed JQL clause names.

getIndexField

public String getIndexField()

Specified by:

getIndexField in interface ClauseInformation

Returns:

the string that represents the field id in the lucene index; may be null if the clause does not search directly on the index e.g. "saved filter" or "all text" clause.

getFieldId

public String getFieldId()

Specified by:

getFieldId in interface ClauseInformation

Returns:

the system or custom field id that this clause is associated with; may be null if the clause does not have a corresponding field e.g. "parent issue" or "saved filter" clause.

getSupportedOperators

public Set<Operator> getSupportedOperators()

Description copied from interface: ClauseInformation

Provides a set of the supported Operator's that this custom field searcher can handle for its searching.

Specified by:

getSupportedOperators in interface ClauseInformation

Returns:

a set of supported operators.

getDataType

public JiraDataType getDataType()

Description copied from interface: ClauseInformation

Provides the JiraDataType that this clause handles and searches on. This allows us to infer some information about how the search will behave and how it will interact with other elements in the system.

For example, if this returns JiraDataTypes.DATE then we know that we could provide users with a date picker for an input field, and we know that this clause should only be used by functions that also specify dates.

Specified by:

getDataType in interface ClauseInformation

Returns:

the JiraDataType that this clause can handle.

See Also:

JiraDataTypes

getInstance

public static IssueKeyConstants getInstance()

getKeyIndexOrderField

public String getKeyIndexOrderField()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object