com.atlassian.jira.jql.validator
Interface OrderByValidator

All Known Implementing Classes:

DefaultOrderByValidator

public interface OrderByValidator

Responsible for validating the StatisticAccessorBean.OrderBy portion of a Query. This will check to see that all the SearchSorts contain orderable jql clause names and that there are no duplicates in the total clause.

Since:

v4.0

Method Summary

MessageSet

validate(com.atlassian.crowd.embedded.api.User searcher, OrderBy orderBy) Will add messages if there is a portion of the order by that contains a non-orderable jql clause name or if there are any duplicates or if the user is trying to order by a field that they can't see.

Method Detail

validate

@NotNull
MessageSet validate(com.atlassian.crowd.embedded.api.User searcher,
                            OrderBy orderBy)

Will add messages if there is a portion of the order by that contains a non-orderable jql clause name or if there are any duplicates or if the user is trying to order by a field that they can't see.

Parameters:

searcher - the user performing the validation.

orderBy - the OrderBy containing the SearchSorts.

Returns:

a MessageSet that will contain i18n'ed messages if something does not pass validation and will be empty if all is well, not null.