com.atlassian.jira.issue.search.constants
Class DefaultClauseInformation
java.lang.Object
com.atlassian.jira.issue.search.constants.DefaultClauseInformation
- All Implemented Interfaces:
- ClauseInformation
@ThreadSafe
public final class DefaultClauseInformation
- extends Object
- implements ClauseInformation
Search constants for time tracking field clauses in JQL e.g. current estimate, original estimate, time spent
- Since:
- v4.0
DefaultClauseInformation
public DefaultClauseInformation(String indexField,
ClauseNames names,
String fieldId,
Set<Operator> supportedOperators,
JiraDataType supportedType)
DefaultClauseInformation
public DefaultClauseInformation(String indexField,
String jqlClauseName,
String fieldId,
Set<Operator> supportedOperators,
JiraDataType supportedType)
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.
getJqlClauseNames
public ClauseNames getJqlClauseNames()
- Specified by:
getJqlClauseNames
in interface ClauseInformation
- Returns:
- the allowed JQL clause names.
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
equals
public boolean equals(Object o)
- Overrides:
equals
in class Object
hashCode
public int hashCode()
- Overrides:
hashCode
in class Object
Copyright © 2002-2013 Atlassian. All Rights Reserved.