@Immutable public class

AliasClauseInformation

extends Object
implements ClauseInformation
java.lang.Object
   ↳ com.atlassian.jira.index.property.AliasClauseInformation

Class Overview

Objects of this class holds all information about the issue property which they alias.

Summary

Public Constructors
AliasClauseInformation(IndexDocumentConfiguration.Type type, String alias, String luceneFieldName, ClauseNames clauseNames, IssuePropertyJql issuePropertyJql, String pluginName)
Public Methods
String getAlias()
JiraDataType getDataType()
Provides the JiraDataType that this clause handles and searches on.
@Nullable String getFieldId()
@Nullable String getIndexField()
IssuePropertyJql getIssuePropertyJql()
ClauseNames getJqlClauseNames()
@Nonnull String getPluginName()
Set<Operator> getSupportedOperators()
Provides a set of the supported Operator's that this custom field searcher can handle for its searching.
boolean isAutoComplete()
boolean isOrderable()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.jql.ClauseInformation

Public Constructors

public AliasClauseInformation (IndexDocumentConfiguration.Type type, String alias, String luceneFieldName, ClauseNames clauseNames, IssuePropertyJql issuePropertyJql, String pluginName)

Public Methods

public String getAlias ()

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.

@Nullable public String getFieldId ()

@Nullable public String getIndexField ()

public IssuePropertyJql getIssuePropertyJql ()

public ClauseNames getJqlClauseNames ()

@Nonnull public String getPluginName ()

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.

public boolean isAutoComplete ()

public boolean isOrderable ()