com.atlassian.jira.issue.search

Interface SearchRequestAppender<T>

All Known Implementing Classes:

CustomFieldSearchRequestAppender

public interface SearchRequestAppender<T>

This interface describes operations for appending clauses to existing SearchRequest queries.

Since:

v6.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SearchRequestAppender.Factory<T>

Method Summary

Methods

Modifier and Type	Method and Description
SearchRequest	appendExclusiveMultiValueClause(Iterable<? extends T> values, SearchRequest searchRequest) Append a multi-value clause to the given SearchRequest, specifying that the given values should not be included.
SearchRequest	appendInclusiveSingleValueClause(T value, SearchRequest searchRequest) Append a single AND clause to the given SearchRequest, specifying that the given single value should be included.

Method Detail

appendInclusiveSingleValueClause

SearchRequest appendInclusiveSingleValueClause(T value,
                                             SearchRequest searchRequest)

Append a single AND clause to the given SearchRequest, specifying that the given single value should be included.

Parameters:

value - The value used to populate the new clause.

searchRequest - The existing query to be used as the basis for the new query. Will not be modified.

Returns:

A new SearchRequest containing the modified query, or null if the new clause cannot be added.

appendExclusiveMultiValueClause

SearchRequest appendExclusiveMultiValueClause(Iterable<? extends T> values,
                                            SearchRequest searchRequest)

Append a multi-value clause to the given SearchRequest, specifying that the given values should not be included.

Parameters:

values - The values used to populate the new clause

searchRequest - The existing query to be used as the basis for the new query. Will not be modified.

Returns:

A new SearchRequest containing the modified query, or null if the new clause cannot be added.