com.atlassian.jira.issue.search.constants
Class PropertyClauseInformation
java.lang.Object
com.atlassian.jira.issue.search.constants.PropertyClauseInformation
- All Implemented Interfaces:
- ClauseInformation
public class PropertyClauseInformation
- extends Object
- implements ClauseInformation
Entity property clause information.
- Since:
- 6.2
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
operators
public static final Set<Operator> operators
PropertyClauseInformation
public PropertyClauseInformation(ClauseNames clauseNames)
getJqlClauseNames
public ClauseNames getJqlClauseNames()
- Specified by:
getJqlClauseNames
in interface ClauseInformation
- Returns:
- the allowed JQL clause names.
getIndexField
@Nullable
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
@Nullable
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
Copyright © 2002-2014 Atlassian. All Rights Reserved.