com.atlassian.jira.issue.customfields.searchers
Interface CustomFieldClauseSanitiserHandler
- All Known Implementing Classes:
- SimpleCustomFieldClauseSanitiserHandler, SimpleCustomFieldClauseSanitiserValueGeneratingHandler
public interface CustomFieldClauseSanitiserHandler
Used to indicate that a particular custom field requires its clauses to be sanitised by a
ClauseSanitiser
. The mechanism for registering the sanitiser is through the
ClausePermissionHandler
, which is constructed by the
SearchableField.createAssociatedSearchHandler()
method.
Thus, when implementing a CustomFieldSearcherClauseHandler
,
ensure that it also implements this interface if it has special sanitisation requirements. Otherwise, the default
NoOpClauseSanitiser
will be used. This searcher clause handler should then
be constructed inside the CustomFieldSearcher
.
- Since:
- v4.0
- See Also:
ClauseSanitiser
getClauseSanitiser
ClauseSanitiser getClauseSanitiser()
- Returns:
- the clause sanitiser to use with this custom field searcher clause handler
Copyright © 2002-2013 Atlassian. All Rights Reserved.