com.atlassian.jira.jql.permission

Interface ClausePermissionChecker

All Known Subinterfaces:

ClausePermissionHandler

All Known Implementing Classes:

CustomFieldClausePermissionChecker, DefaultClausePermissionHandler, FieldClausePermissionChecker, IssueParentPermissionChecker, IssuePropertyClausePermissionChecker, MockClausePermissionChecker, NoOpClausePermissionChecker, StatusCategoryPermissionChecker, TimeTrackingPermissionChecker, VotePermissionChecker, WatchPermissionChecker

public interface ClausePermissionChecker

Checks to see that the provided user is able to use the clause.

Since:

v4.0

Method Summary

Modifier and Type	Method and Description
boolean	hasPermissionToUseClause(ApplicationUser user) Checks to see that the provided user is able to use the clause.
boolean	hasPermissionToUseClause(ApplicationUser user, Set<FieldLayout> fieldLayouts) Checks to see that the provided user is able to use the clause.

Method Detail

hasPermissionToUseClause

boolean hasPermissionToUseClause(ApplicationUser user)

Checks to see that the provided user is able to use the clause. This may be as simple as determining if the user has permission to see the field that the clause represents.

Parameters:

user - to check permissions against.

Returns:

true if the user can use this clause, false otherwise.

hasPermissionToUseClause

boolean hasPermissionToUseClause(ApplicationUser user,
                                 Set<FieldLayout> fieldLayouts)

Checks to see that the provided user is able to use the clause. This method provides all the FieldLayouts visible to the given user as a shortcut otherwise individual checkers can end up looking this up dozens or even hundreds of times with causes slow downs in our search (see JRADEV-15665).

Parameters:

user - to check permissions against.

fieldLayouts - The field Layouts available to the given user (value of com.atlassian.jira.issue.fields.FieldManager#getVisibleFieldLayouts(User).

Returns:

true if the user can use this clause, false otherwise.