Summary: Methods | [Expand All]
@Immutable public interface

ClauseInformation

com.atlassian.jira.jql.ClauseInformation
Known Indirect Subclasses

Class Overview

Used to tie together field names, JQL clause names, and document constant names.

Summary

Public Methods
JiraDataType getDataType()
Provides the JiraDataType that this clause handles and searches on.
@Nullable String getFieldId()
@Nullable String getIndexField()
ClauseNames getJqlClauseNames()
Set<Operator> getSupportedOperators()
Provides a set of the supported Operator's that this custom field searcher can handle for its searching.

Public Methods

public JiraDataType getDataType ()

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 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.

Returns
  • the JiraDataType that this clause can handle.
See Also

@Nullable public String getFieldId ()

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.

@Nullable public String getIndexField ()

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.

public ClauseNames getJqlClauseNames ()

Returns
  • the allowed JQL clause names.

public Set<Operator> getSupportedOperators ()

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

Returns
  • a set of supported operators.