StructurePluginHelper (Structure API 16.10.0 API)

```
@Internal
public interface StructurePluginHelper
```
StructurePluginHelper is a helper component that provides a lot of helpful methods and which is extensively used by Structure plugin itself and by Structure extensions.

As a consumer of Structure API, you can also benefit from using these methods, however, since this class is marked @Internal, you may need to retest or recompile your code with every new minor or micro release of the Structure API.

The methods in this class form several groups:
- Quick access to components,
- Permission and access checks,
- Web resource utilities for building pages that include Structure widget,
- Searching and filtering utilities,
- I18n tools,
- Caching and lifecycle tools,
- Miscellaneous helper methods.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`clearAllCaches()` Clears all caches on the current JIRA instance that are maintained by Structure and Structure extensions.
`void`	`clearAllCachesOnAllNodes()` Clears all caches (maintained by Structure and Structure extensions) on the current JIRA instance and causes eventual caches clearing on other nodes (when running on JIRA Data Center).
`void`	`clearCurrentUserCaches()` Clears caches on the current node for the current user.
`void`	`clearUserCaches(com.atlassian.jira.user.ApplicationUser user)` Clears caches on the current node for the given non-anonymous user.
`void`	`filterInvisibleProjects(com.almworks.integers.LongSizedIterable projects, com.atlassian.jira.user.ApplicationUser user, boolean overrideSecurity, com.almworks.integers.LongCollector invisibleCollector)` Used to figure out which projects are not visible to the user.
`com.atlassian.jira.security.JiraAuthenticationContext`	`getAuthenticationContext()`
`List<com.atlassian.crowd.embedded.api.Group>`	`getAvailableGroups(com.atlassian.jira.user.ApplicationUser user)` Retrieves the security groups that the user is allowed to see.
`default List<com.atlassian.crowd.embedded.api.Group>`	`getAvailableGroupsForCurrentUser()` Retrieves the security groups that the current user is allowed to see.
`List<com.atlassian.jira.security.roles.ProjectRole>`	`getAvailableRoles()` Retrieves the roles that exist in the system.
`Collator`	`getCollator(com.atlassian.jira.user.ApplicationUser user)` Returns a collator for strings in the user's locale.
`StructureConfiguration`	`getConfiguration()` Retrieves `StructureConfiguration`
`default com.atlassian.query.Query`	`getConfigurationScopeQuery()` Retrieves a query that limits scope to the projects enabled for Structure.
`com.atlassian.jira.issue.CustomFieldManager`	`getCustomFieldManager()`
`com.atlassian.plugin.event.PluginEventManager`	`getEventManager()`
`com.atlassian.jira.security.GlobalPermissionManager`	`getGlobalPermissionManager()`
`default com.atlassian.jira.util.I18nHelper`	`getI18n()` Retrieves i18n helper for the current user.
`com.atlassian.jira.util.I18nHelper`	`getI18n(com.atlassian.jira.user.ApplicationUser user)` Retrieves i18n helper for a concrete user.
`com.atlassian.jira.issue.Issue`	`getIssue(long issueId)` Retrieves an instance of `Issue`.
`com.atlassian.jira.issue.Issue`	`getIssue(String key)` Retrieves an instance of issue by issue key.
`default StructureError`	`getIssueError(com.atlassian.jira.issue.Issue issue, boolean checkEdit)` Convenience method to check issue access for the current user.
`default StructureError`	`getIssueError(com.atlassian.jira.issue.Issue issue, boolean checkEdit, boolean checkProjectEnabledForStructure)` Convenience method to check issue access for the current user.
`StructureError`	`getIssueError(com.atlassian.jira.issue.Issue issue, boolean checkEdit, boolean checkProjectEnabledForStructure, com.atlassian.jira.user.ApplicationUser user)` Checks user access to the issue for viewing or editing.
`default StructureError`	`getIssueError(Long issue, boolean checkEdit)` Convenience method to check issue access for the current user.
`StructureError`	`getIssueError(Long issue, boolean checkEdit, com.atlassian.jira.user.ApplicationUser user)` Checks user access to the issue for viewing or editing.
`com.atlassian.jira.issue.IssueManager`	`getIssueManager()`
`com.atlassian.jira.jql.operand.JqlOperandResolver`	`getJqlOperandResolver()`
`com.atlassian.jira.jql.parser.JqlQueryParser`	`getJqlQueryParser()`
`com.atlassian.jira.jql.util.JqlStringSupport`	`getJqlStringSupport()`
`Locale`	`getLocale()` Returns the current user's locale.
`com.atlassian.jira.security.PermissionManager`	`getPermissionManager()`
`com.atlassian.plugin.PluginAccessor`	`getPluginAccessor()`
`com.atlassian.jira.project.ProjectManager`	`getProjectManager()`
`com.atlassian.jira.security.roles.ProjectRoleManager`	`getProjectRoleManager()`
`List<com.atlassian.jira.project.Project>`	`getProjectsForCurrentUser()` Retrieves the list of projects that are visible to the current user.
`com.atlassian.jira.issue.search.SearchRequestManager`	`getSearchRequestManager()`
`com.atlassian.jira.bc.issue.search.SearchService`	`getSearchService()`
`com.atlassian.jira.web.session.SessionSearchObjectManagerFactory`	`getSessionSearchObjectManagerFactory()`
`Comparator<Structure>`	`getStructureComparator(com.atlassian.jira.user.ApplicationUser user)` Returns comparator for sorting structures by name, according to the given user's locale.
`List<com.atlassian.jira.project.Project>`	`getStructureProjectsForCurrentUser()` Retrieves the list of projects that are enabled for structure and visible to the current user.
`com.atlassian.jira.bc.issue.worklog.TimeTrackingConfiguration`	`getTimeTrackingConfiguration()`
`com.atlassian.jira.user.ApplicationUser`	`getUser()` Retrieves the current user.
`com.atlassian.jira.user.util.UserManager`	`getUserManager()`
`com.atlassian.jira.user.preferences.UserPreferencesManager`	`getUserPreferencesManager()`
`boolean`	`hasPermission(com.atlassian.jira.permission.GlobalPermissionKey permission, com.atlassian.jira.user.ApplicationUser user)` Checks if the given user has the given global permission.
`boolean`	`hasPermission(com.atlassian.jira.security.plugin.ProjectPermissionKey permission, com.atlassian.jira.issue.Issue issue, com.atlassian.jira.user.ApplicationUser user)` Checks if the given user has the given project-level permission on an issue's project.
`boolean`	`hasPermission(com.atlassian.jira.security.plugin.ProjectPermissionKey permission, com.atlassian.jira.project.Project project, com.atlassian.jira.user.ApplicationUser user)` Checks if the given user has the given project-level permission on a project.
`<T> T`	`instantiate(Class<T> clazz)` Creates a new instance of the given class, injecting all dependencies into the constructor.
`default boolean`	`isAdmin()` Checks if the current user is a JIRA administrator (but not necessarily JIRA's "System Administrator"!).
`boolean`	`isAdmin(com.atlassian.jira.user.ApplicationUser user)` Checks if the given user is a JIRA administrator (but not necessarily JIRA's "System Administrator"!).
`default boolean`	`isAuthenticated()` Checks if the current user has authenticated in the system.
`boolean`	`isAutomationAccessAllowed(com.atlassian.jira.user.ApplicationUser user)` Checks if the given user is allowed to create and run generators.
`boolean`	`isCreateStructureAllowed(com.atlassian.jira.user.ApplicationUser user)` Checks if the given user is allowed to create new structures.
`boolean`	`isIssueEditable(com.atlassian.jira.issue.Issue issue, com.atlassian.jira.user.ApplicationUser user)` Checks if the issue can be edited by the given user.
`boolean`	`isProjectStructuredForCurrentUser(com.atlassian.jira.project.Project project)` Checks if the project is enabled for Structure and the current user can see it.
`default boolean`	`isStructureAvailableToCurrentUser()` Checks if the current user is allowed to work with Structure add-on.
`boolean`	`isStructureAvailableToUser(com.atlassian.jira.user.ApplicationUser user)` Checks if the given user is allowed to work with Structure add-on.
`boolean`	`isStructureLocked()` Returns true when Structure cannot be used because it is locked, either for full restore or for system startup.
`boolean`	`isSynchronizationAllowed(com.atlassian.jira.user.ApplicationUser user)` Checks if the given user is allowed to create and run synchronizers.
`boolean`	`isViewCreationAllowed(com.atlassian.jira.user.ApplicationUser user)` Checks if the given user can create new views.
`boolean`	`isViewSharingAllowed(com.atlassian.jira.user.ApplicationUser user)` Checks if the given user can share views.
`void`	`matchIssues(com.almworks.integers.LongList issues, com.atlassian.query.Query query, boolean collectMatching, com.almworks.integers.LongCollector collector)` Passes the issues through JIRA search engine and lets the caller collect either all matching or non-matching issues.
`void`	`matchIssuesSorted(com.almworks.integers.LongList issuesSorted, com.atlassian.query.Query query, boolean collectMatching, com.atlassian.jira.user.ApplicationUser user, boolean overrideSecurity, com.almworks.integers.LongCollector collector)` A variation of `matchIssuesSorted(LongList, Query, boolean, LongCollector)` that lets you specify the user and override security checks.
`void`	`matchIssuesSorted(com.almworks.integers.LongList issuesSorted, com.atlassian.query.Query query, boolean collectMatching, com.almworks.integers.LongCollector collector)` Passes the issues, sorted by their IDs, through JIRA search engine to collect matching or non-matching issues.
`void`	`requireIssueDetailsResources()` Loads resources needed for the issue details layout.
`void`	`requireIssueShortcuts()` Loads resources needed for standard JIRA keyboard shortcuts.
`void`	`requireLocalizedResource(String resourceKey)` Requires a resource that may be localized.
`void`	`requireQuickEditResources()` Loads resources needed for "quick edit" code to work (dialog with editing / creating an issue).
`void`	`requireResource(String resourceKey)` Marks resource as needed for loading.
`void`	`requireResourceIfPresent(String resourceKey)` Marks resource as needed for loading, if the resource exists.
`void`	`requireWidgetResource()` Requires all resources needed to render Structure Widget.
`com.almworks.integers.LongArray`	`searchAndSortQuery(com.atlassian.query.Query query)` Runs search with sorting.
`com.almworks.integers.LongArray`	`searchAndSortQuery(com.atlassian.query.Query query, int limit)` Runs search with sorting and result count limit.
`com.almworks.integers.LongArray`	`searchAndSortQuery(String query)` Runs JQL search with sorting.
`com.almworks.integers.LongArray`	`searchQuery(com.atlassian.query.Query query)` Runs search.
`com.almworks.integers.LongArray`	`searchQuery(String query)` Runs JQL search.
`com.atlassian.jira.util.MessageSet`	`validateQuery(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query)` Checks if the query is valid and that the user has access to all the things mentioned in the query.

- Method Detail
  - getIssueError
```
@Nullable
StructureError getIssueError(@Nullable
                                        Long issue,
                                        boolean checkEdit,
                                        @Nullable
                                        com.atlassian.jira.user.ApplicationUser user)
```
    Checks user access to the issue for viewing or editing. Edit check includes verifying that issue editing is not prohibited by workflow.
    
    Parameters:
    
    issue - issue ID
    
    checkEdit - if true, edit permissions are required.
    
    user - user to check for
    
    Returns:
    
    specific error or null if everything is ok
  - getIssueError
```
@Nullable
default StructureError getIssueError(@Nullable
                                                Long issue,
                                                boolean checkEdit)
```
    Convenience method to check issue access for the current user.
    
    Parameters:
    
    issue - issue ID
    
    checkEdit - if true, edit permissions are required.
    
    Returns:
    
    specific error or null if everything is ok
    
    See Also:
    
    getIssueError(Long, boolean, ApplicationUser)
  - getIssueError
```
@Contract(value="null, _, _, _ -> !null")
 @Nullable
StructureError getIssueError(@Nullable
                                                                                    com.atlassian.jira.issue.Issue issue,
                                                                                    boolean checkEdit,
                                                                                    boolean checkProjectEnabledForStructure,
                                                                                    @Nullable
                                                                                    com.atlassian.jira.user.ApplicationUser user)
```
    Checks user access to the issue for viewing or editing. Edit check includes verifying that issue editing is not prohibited by workflow. Also can check if the project that the issue belongs to is enabled for Structure.
    
    Parameters:
    
    issue - issue
    
    checkEdit - if true, edit permissions are required
    
    checkProjectEnabledForStructure - if true, issue's project must be enabled for Structure
    
    user - user to check for
    
    Returns:
    
    specific error or null if everything is ok
  - getIssueError
```
@Contract(value="null, _ -> !null")
 @Nullable
default StructureError getIssueError(@Nullable
                                                                                      com.atlassian.jira.issue.Issue issue,
                                                                                      boolean checkEdit)
```
    Convenience method to check issue access for the current user.
    
    Parameters:
    
    issue - issue
    
    checkEdit - if true, edit permissions are required
    
    Returns:
    
    specific error or null if everything is ok
    
    See Also:
    
    getIssueError(Issue, boolean, boolean, ApplicationUser)
  - getIssueError
```
@Contract(value="null, _, _ -> !null")
 @Nullable
default StructureError getIssueError(@Nullable
                                                                                         com.atlassian.jira.issue.Issue issue,
                                                                                         boolean checkEdit,
                                                                                         boolean checkProjectEnabledForStructure)
```
    Convenience method to check issue access for the current user.
    
    Parameters:
    
    issue - issue
    
    checkEdit - if true, edit permissions are required
    
    checkProjectEnabledForStructure - if true, issue's project must be enabled for Structure
    
    Returns:
    
    specific error or null if everything is ok
    
    See Also:
    
    getIssueError(Issue, boolean, boolean, ApplicationUser)
  - isProjectStructuredForCurrentUser
```
boolean isProjectStructuredForCurrentUser(@Nullable
                                          com.atlassian.jira.project.Project project)
```
    Checks if the project is enabled for Structure and the current user can see it.
    
    Parameters:
    
    project - the project
    
    Returns:
    
    true if the project is "structured" and visible to the current user
  - isStructureAvailableToUser
```
boolean isStructureAvailableToUser(@Nullable
                                   com.atlassian.jira.user.ApplicationUser user)
```
    Checks if the given user is allowed to work with Structure add-on.
    
    Returns:
    
    true if the given user can work with Structure
  - isStructureAvailableToCurrentUser
```
default boolean isStructureAvailableToCurrentUser()
```
    Checks if the current user is allowed to work with Structure add-on.
    
    Returns:
    
    true if the current user can work with Structure
  - isCreateStructureAllowed
```
boolean isCreateStructureAllowed(@Nullable
                                 com.atlassian.jira.user.ApplicationUser user)
```
    Checks if the given user is allowed to create new structures.
  - isSynchronizationAllowed
```
boolean isSynchronizationAllowed(@Nullable
                                 com.atlassian.jira.user.ApplicationUser user)
```
    Checks if the given user is allowed to create and run synchronizers.
  - isAutomationAccessAllowed
```
boolean isAutomationAccessAllowed(@Nullable
                                  com.atlassian.jira.user.ApplicationUser user)
```
    Checks if the given user is allowed to create and run generators.
  - isAuthenticated
```
default boolean isAuthenticated()
```
    Checks if the current user has authenticated in the system.
    
    Returns:
    
    true if the current user is not anonymous
  - isAdmin
```
boolean isAdmin(@Nullable
                com.atlassian.jira.user.ApplicationUser user)
```
    Checks if the given user is a JIRA administrator (but not necessarily JIRA's "System Administrator"!).
    
    Returns:
    
    true if the given user is an admin.
  - isAdmin
```
default boolean isAdmin()
```
    Checks if the current user is a JIRA administrator (but not necessarily JIRA's "System Administrator"!).
    
    Returns:
    
    true if the current user is an admin.
  - isViewCreationAllowed
```
boolean isViewCreationAllowed(@Nullable
                              com.atlassian.jira.user.ApplicationUser user)
```
    Checks if the given user can create new views.
  - isViewSharingAllowed
```
boolean isViewSharingAllowed(@Nullable
                             com.atlassian.jira.user.ApplicationUser user)
```
    Checks if the given user can share views.
  - isIssueEditable
```
boolean isIssueEditable(@Nullable
                        com.atlassian.jira.issue.Issue issue,
                        @Nullable
                        com.atlassian.jira.user.ApplicationUser user)
```
    Checks if the issue can be edited by the given user. Besides permissions, the issue may be non-editable because of workflow.
    
    Parameters:
    
    issue - issue in question
    
    user - user to make the edit
    
    Returns:
    
    true if the user can now edit the issue
  - hasPermission
```
boolean hasPermission(@NotNull
                      com.atlassian.jira.permission.GlobalPermissionKey permission,
                      @Nullable
                      com.atlassian.jira.user.ApplicationUser user)
```
    Checks if the given user has the given global permission.
    
    Parameters:
    
    permission - global permission
    
    user - user in question
    
    Returns:
    
    true if permission is granted
  - hasPermission
```
boolean hasPermission(@NotNull
                      com.atlassian.jira.security.plugin.ProjectPermissionKey permission,
                      @Nullable
                      com.atlassian.jira.issue.Issue issue,
                      @Nullable
                      com.atlassian.jira.user.ApplicationUser user)
```
    Checks if the given user has the given project-level permission on an issue's project.
    
    Parameters:
    
    permission - project permission from ProjectPermissions
    
    issue - an issue
    
    user - user in question
    
    Returns:
    
    true if permission is granted
  - hasPermission
```
boolean hasPermission(@NotNull
                      com.atlassian.jira.security.plugin.ProjectPermissionKey permission,
                      @Nullable
                      com.atlassian.jira.project.Project project,
                      @Nullable
                      com.atlassian.jira.user.ApplicationUser user)
```
    Checks if the given user has the given project-level permission on a project.
    
    Parameters:
    
    permission - project permission from ProjectPermissions
    
    project - a project
    
    user - user in question
    
    Returns:
    
    true if permission is granted
  - getUser
```
@Nullable
com.atlassian.jira.user.ApplicationUser getUser()
```
    Retrieves the current user.
    
    Returns:
    
    current user
    
    See Also:
    
    StructureAuth
  - getAvailableGroups
```
@NotNull
List<com.atlassian.crowd.embedded.api.Group> getAvailableGroups(@Nullable
                                                                          com.atlassian.jira.user.ApplicationUser user)
```
    Retrieves the security groups that the user is allowed to see. JIRA admin is allowed to see all groups. All non-admin users are allowed to see the groups they are in.
    
    Parameters:
    
    user - user
    
    Returns:
    
    groups that the user is allowed to see
  - getAvailableGroupsForCurrentUser
```
@NotNull
default List<com.atlassian.crowd.embedded.api.Group> getAvailableGroupsForCurrentUser()
```
    Retrieves the security groups that the current user is allowed to see. JIRA admin is allowed to see all groups. All non-admin users are allowed to see the groups they are in.
    
    Returns:
    
    groups that the current user is allowed to see
  - getAvailableRoles
```
@NotNull
List<com.atlassian.jira.security.roles.ProjectRole> getAvailableRoles()
```
    Retrieves the roles that exist in the system. The returned list is owned by the caller and may be modified.
  - getStructureProjectsForCurrentUser
```
@NotNull
List<com.atlassian.jira.project.Project> getStructureProjectsForCurrentUser()
```
    Retrieves the list of projects that are enabled for structure and visible to the current user. The returned list is owned by the caller and may be modified.
  - getProjectsForCurrentUser
```
@NotNull
List<com.atlassian.jira.project.Project> getProjectsForCurrentUser()
```
    Retrieves the list of projects that are visible to the current user. The returned list is owned by the caller and may be modified. The returned projects may not be enabled for structure.
  - getAuthenticationContext
```
@NotNull
com.atlassian.jira.security.JiraAuthenticationContext getAuthenticationContext()
```
  - getIssueManager
```
@NotNull
com.atlassian.jira.issue.IssueManager getIssueManager()
```
  - getPermissionManager
```
@NotNull
com.atlassian.jira.security.PermissionManager getPermissionManager()
```
  - getPluginAccessor
```
@NotNull
com.atlassian.plugin.PluginAccessor getPluginAccessor()
```
  - getEventManager
```
@NotNull
com.atlassian.plugin.event.PluginEventManager getEventManager()
```
  - getProjectManager
```
@NotNull
com.atlassian.jira.project.ProjectManager getProjectManager()
```
  - getProjectRoleManager
```
@NotNull
com.atlassian.jira.security.roles.ProjectRoleManager getProjectRoleManager()
```
  - getUserManager
```
@NotNull
com.atlassian.jira.user.util.UserManager getUserManager()
```
  - getJqlStringSupport
```
@NotNull
com.atlassian.jira.jql.util.JqlStringSupport getJqlStringSupport()
```
  - getJqlQueryParser
```
@NotNull
com.atlassian.jira.jql.parser.JqlQueryParser getJqlQueryParser()
```
  - getSearchService
```
@NotNull
com.atlassian.jira.bc.issue.search.SearchService getSearchService()
```
  - getSessionSearchObjectManagerFactory
```
@NotNull
com.atlassian.jira.web.session.SessionSearchObjectManagerFactory getSessionSearchObjectManagerFactory()
```
  - getJqlOperandResolver
```
@NotNull
com.atlassian.jira.jql.operand.JqlOperandResolver getJqlOperandResolver()
```
  - getSearchRequestManager
```
@NotNull
com.atlassian.jira.issue.search.SearchRequestManager getSearchRequestManager()
```
  - getGlobalPermissionManager
```
@NotNull
com.atlassian.jira.security.GlobalPermissionManager getGlobalPermissionManager()
```
  - getTimeTrackingConfiguration
```
@NotNull
com.atlassian.jira.bc.issue.worklog.TimeTrackingConfiguration getTimeTrackingConfiguration()
```
  - getUserPreferencesManager
```
@NotNull
com.atlassian.jira.user.preferences.UserPreferencesManager getUserPreferencesManager()
```
  - getCustomFieldManager
```
@NotNull
com.atlassian.jira.issue.CustomFieldManager getCustomFieldManager()
```
  - requireWidgetResource
```
void requireWidgetResource()
```
    Requires all resources needed to render Structure Widget.
  - requireLocalizedResource
```
void requireLocalizedResource(@NotNull
                              String resourceKey)
```
    Requires a resource that may be localized. A localized version of the resource will have _locale suffix in its key - for example, com.almworks.jira.structure:my-resource_de
    
    The locale of current user is used to load the resource. If such resource is missing, nothing happens.
    
    Parameters:
    
    resourceKey - base resource key
  - requireResource
```
void requireResource(@NotNull
                     String resourceKey)
```
    Marks resource as needed for loading. Must be called before a page starts being rendered. If resource is missing, JIRA logs a warning but rendering continues.
    
    Parameters:
    
    resourceKey - resource key
  - requireResourceIfPresent
```
void requireResourceIfPresent(String resourceKey)
```
    Marks resource as needed for loading, if the resource exists. If the resource is missing, nothing happens. Must be called before a page starts being rendered.
    
    Parameters:
    
    resourceKey - resource key
    
    See Also:
    
    requireResource(String)
  - requireIssueDetailsResources
```
void requireIssueDetailsResources()
```
    Loads resources needed for the issue details layout.
  - requireQuickEditResources
```
void requireQuickEditResources()
```
    Loads resources needed for "quick edit" code to work (dialog with editing / creating an issue).
  - requireIssueShortcuts
```
void requireIssueShortcuts()
```
    Loads resources needed for standard JIRA keyboard shortcuts.
  - filterInvisibleProjects
```
void filterInvisibleProjects(@Nullable
                             com.almworks.integers.LongSizedIterable projects,
                             @Nullable
                             com.atlassian.jira.user.ApplicationUser user,
                             boolean overrideSecurity,
                             @NotNull
                             com.almworks.integers.LongCollector invisibleCollector)
```
    Used to figure out which projects are not visible to the user. The list of project IDs may contain non-existent IDs - they will also be reported as invisible.
    
    Parameters:
    
    projects - list of project IDs
    
    user - the user
    
    overrideSecurity - if true, permissions don't matter, only project existence is checked
    
    invisibleCollector - a collector to get the IDs of invisible projects
  - searchQuery
```
@NotNull
com.almworks.integers.LongArray searchQuery(@Nullable
                                                      String query)
                                               throws com.atlassian.jira.issue.search.SearchException,
                                                      com.atlassian.jira.jql.parser.JqlParseException
```
    Runs JQL search.
    
    Parameters:
    
    query - JQL (empty or null string will result in empty result)
    
    Returns:
    
    IDs of matching issues
    
    Throws:
    
    com.atlassian.jira.issue.search.SearchException - if search problem happened
    
    com.atlassian.jira.jql.parser.JqlParseException - if JQL is invalid
  - searchQuery
```
@NotNull
com.almworks.integers.LongArray searchQuery(@Nullable
                                                      com.atlassian.query.Query query)
                                               throws com.atlassian.jira.issue.search.SearchException
```
    Runs search.
    
    Parameters:
    
    query - query
    
    Returns:
    
    IDs of matching issues
    
    Throws:
    
    com.atlassian.jira.issue.search.SearchException - if search problem happened
  - searchAndSortQuery
```
@NotNull
com.almworks.integers.LongArray searchAndSortQuery(@Nullable
                                                             String query)
                                                      throws com.atlassian.jira.issue.search.SearchException,
                                                             com.atlassian.jira.jql.parser.JqlParseException
```
    Runs JQL search with sorting.
    
    Parameters:
    
    query - JQL (empty or null string will result in empty result)
    
    Returns:
    
    IDs of matching issues
    
    Throws:
    
    com.atlassian.jira.issue.search.SearchException - if search problem happened
    
    com.atlassian.jira.jql.parser.JqlParseException - if JQL is invalid
  - searchAndSortQuery
```
@NotNull
com.almworks.integers.LongArray searchAndSortQuery(@Nullable
                                                             com.atlassian.query.Query query)
                                                      throws com.atlassian.jira.issue.search.SearchException
```
    Runs search with sorting.
    
    Parameters:
    
    query - query
    
    Returns:
    
    IDs of matching issues
    
    Throws:
    
    com.atlassian.jira.issue.search.SearchException - if search problem happened
  - searchAndSortQuery
```
@NotNull
com.almworks.integers.LongArray searchAndSortQuery(@Nullable
                                                             com.atlassian.query.Query query,
                                                             int limit)
                                                      throws com.atlassian.jira.issue.search.SearchException
```
    Runs search with sorting and result count limit.
    
    Parameters:
    
    query - query
    
    limit - maximum number of issues in the result
    
    Returns:
    
    IDs of matching issues
    
    Throws:
    
    com.atlassian.jira.issue.search.SearchException - if search problem happened
  - matchIssues
```
void matchIssues(@Nullable
                 com.almworks.integers.LongList issues,
                 @Nullable
                 com.atlassian.query.Query query,
                 boolean collectMatching,
                 @NotNull
                 com.almworks.integers.LongCollector collector)
          throws com.atlassian.jira.issue.search.SearchException
```
    Passes the issues through JIRA search engine and lets the caller collect either all matching or non-matching issues.
    
    The implementation sorts issues and splits them up into chunks (of 100+ ids each) and creates a JQL query for each. This has proven to be a quick method of checking. However, if the number of issues is likely to be the same order of magnitude as the full result of the query, it's better to run the full query and compare result with the list.
    
    The issues are checked to be accessible for the current user - so no need to run additional BROWSE permission checks. You can quickly check which issues among the list are visible to the user by running matchIssues() with null query.
    
    If it is certain that the issue list is sorted, it's more efficient to call matchIssuesSorted(com.almworks.integers.LongList, com.atlassian.query.Query, boolean, com.almworks.integers.LongCollector).
    
    If you need to skip checking for the user access or check access for non-current user, use com.almworks.jira.structure.api.auth.StructureAuth#sudo).
    
    Parameters:
    
    query - query to check against. If null, the issues are only checked to be visible to the user and to the Structure plugin
    
    issues - issue IDs
    
    collectMatching - if true, collector will receive the issues that match query and visible to the user; if false, collector will receive non-matching issues
    
    collector - an instance for receiving the results. Chunks are processed in order, for each chunk the (non-)matching issues are added. No guarantees are made for the order of the results inside the same chunk.
    
    Throws:
    
    com.atlassian.jira.issue.search.SearchException - if a bad thing happens
  - matchIssuesSorted
```
void matchIssuesSorted(@Nullable
                       com.almworks.integers.LongList issuesSorted,
                       @Nullable
                       com.atlassian.query.Query query,
                       boolean collectMatching,
                       com.almworks.integers.LongCollector collector)
                throws com.atlassian.jira.issue.search.SearchException
```
    Passes the issues, sorted by their IDs, through JIRA search engine to collect matching or non-matching issues.
    
    This is more efficient method than matchIssues(com.almworks.integers.LongList, com.atlassian.query.Query, boolean, com.almworks.integers.LongCollector) if you already have IDs sorted.
    
    Parameters:
    
    issuesSorted - issues list
    
    query - additional query
    
    collectMatching - if true, collector receives matching issues, if false, collector receives non-matching issues.
    
    collector - the collector
    
    Throws:
    
    com.atlassian.jira.issue.search.SearchException - if a bad thing happens
    
    See Also:
    
    matchIssues(LongList, Query, boolean, LongCollector)
  - matchIssuesSorted
```
void matchIssuesSorted(@Nullable
                       com.almworks.integers.LongList issuesSorted,
                       @Nullable
                       com.atlassian.query.Query query,
                       boolean collectMatching,
                       @Nullable
                       com.atlassian.jira.user.ApplicationUser user,
                       boolean overrideSecurity,
                       com.almworks.integers.LongCollector collector)
                throws com.atlassian.jira.issue.search.SearchException
```
    A variation of matchIssuesSorted(LongList, Query, boolean, LongCollector) that lets you specify the user and override security checks.
    
    Parameters:
    
    issuesSorted - issues list
    
    query - additional query
    
    collectMatching - if true, collector receives matching issues, if false, collector receives non-matching issues.
    
    user - the user that will be used to check access
    
    overrideSecurity - if true, user access will not be checked
    
    collector - the collector
    
    Throws:
    
    com.atlassian.jira.issue.search.SearchException - if a bad thing happens
    
    See Also:
    
    matchIssues(LongList, Query, boolean, LongCollector), StructureAuth.sudo(ApplicationUser, boolean, CallableE)
  - validateQuery
```
@NotNull
com.atlassian.jira.util.MessageSet validateQuery(com.atlassian.jira.user.ApplicationUser user,
                                                           com.atlassian.query.Query query)
```
    Checks if the query is valid and that the user has access to all the things mentioned in the query.
    
    Parameters:
    
    user - user
    
    query - query
    
    Returns:
    
    a collection of error messages
  - getConfigurationScopeQuery
```
@Nullable
default com.atlassian.query.Query getConfigurationScopeQuery()
```
    Retrieves a query that limits scope to the projects enabled for Structure. You can use that query to combine with whatever business logic query you have.
    
    Returns:
    
    configuration query ("project in ...") or null if Structure is allowed for all projects
    
    See Also:
    
    StructureConfiguration.getConfigurationScopeQuery()
  - getI18n
```
@NotNull
com.atlassian.jira.util.I18nHelper getI18n(@Nullable
                                                     com.atlassian.jira.user.ApplicationUser user)
```
    Retrieves i18n helper for a concrete user.
    
    Parameters:
    
    user - the user
    
    Returns:
    
    i18n helper
  - getI18n
```
@NotNull
default com.atlassian.jira.util.I18nHelper getI18n()
```
    Retrieves i18n helper for the current user.
  - getStructureComparator
```
@NotNull
Comparator<Structure> getStructureComparator(@Nullable
                                                       com.atlassian.jira.user.ApplicationUser user)
```
    Returns comparator for sorting structures by name, according to the given user's locale.
    
    Parameters:
    
    user - the user to take locale from
    
    Returns:
    
    a comparator that can be used to sort structures
  - getCollator
```
@NotNull
Collator getCollator(@Nullable
                               com.atlassian.jira.user.ApplicationUser user)
```
    Returns a collator for strings in the user's locale.
    
    Parameters:
    
    user - the user
    
    Returns:
    
    collator
  - getLocale
```
@NotNull
Locale getLocale()
```
    Returns the current user's locale.
  - clearAllCaches
```
void clearAllCaches()
```
    Clears all caches on the current JIRA instance that are maintained by Structure and Structure extensions.
    
    Note that in JIRA Data Center environment, this does not clear caches on other nodes.
    
    After this method has finished execution, the caches are cleared.
    
    See Also:
    
    CachingComponent, clearAllCachesOnAllNodes()
  - clearAllCachesOnAllNodes
```
void clearAllCachesOnAllNodes()
```
    Clears all caches (maintained by Structure and Structure extensions) on the current JIRA instance and causes eventual caches clearing on other nodes (when running on JIRA Data Center).
    
    When running on non-JDC instance, works the same as clearAllCaches().
    
    After this method has finished execution, the caches are cleared on the local node, but may not be cleared yet on other nodes.
    
    See Also:
    
    CachingComponent, clearAllCaches()
  - clearCurrentUserCaches
```
void clearCurrentUserCaches()
```
    Clears caches on the current node for the current user.
  - clearUserCaches
```
void clearUserCaches(@NotNull
                     com.atlassian.jira.user.ApplicationUser user)
```
    Clears caches on the current node for the given non-anonymous user.
  - isStructureLocked
```
boolean isStructureLocked()
```
    Returns true when Structure cannot be used because it is locked, either for full restore or for system startup.
  - getIssue
```
@Nullable
com.atlassian.jira.issue.Issue getIssue(long issueId)
```
    Retrieves an instance of Issue.
    
    Parameters:
    
    issueId - the ID of the issue
    
    Returns:
    
    the issue, or null if the issue cannot be found or there is an exception getting it
  - getIssue
```
@Nullable
com.atlassian.jira.issue.Issue getIssue(String key)
```
    Retrieves an instance of issue by issue key.
    
    Parameters:
    
    key - issue key
    
    Returns:
    
    the issue, or null if the issue cannot be found or there is an exception getting it
  - getConfiguration
```
@NotNull
StructureConfiguration getConfiguration()
```
    Retrieves StructureConfiguration
  - instantiate
```
<T> T instantiate(@NotNull
                  Class<T> clazz)
```
    Creates a new instance of the given class, injecting all dependencies into the constructor. Those dependencies may include other Structure's services or system services.
    
    Type Parameters:
    
    T - type parameter
    
    Parameters:
    
    clazz - class to be instantiated
    
    Returns:
    
    created instance

Interface StructurePluginHelper

Method Summary

Method Detail

getIssueError

getIssueError

getIssueError

getIssueError

getIssueError

isProjectStructuredForCurrentUser

isStructureAvailableToUser

isStructureAvailableToCurrentUser

isCreateStructureAllowed

isSynchronizationAllowed

isAutomationAccessAllowed

isAuthenticated

isAdmin

isAdmin

isViewCreationAllowed

isViewSharingAllowed

isIssueEditable

hasPermission

hasPermission

hasPermission

getUser

getAvailableGroups

getAvailableGroupsForCurrentUser

getAvailableRoles

getStructureProjectsForCurrentUser

getProjectsForCurrentUser

getAuthenticationContext

getIssueManager

getPermissionManager

getPluginAccessor

getEventManager

getProjectManager

getProjectRoleManager

getUserManager

getJqlStringSupport

getJqlQueryParser

getSearchService

getSessionSearchObjectManagerFactory

getJqlOperandResolver

getSearchRequestManager

getGlobalPermissionManager

getTimeTrackingConfiguration

getUserPreferencesManager

getCustomFieldManager

requireWidgetResource

requireLocalizedResource

requireResource

requireResourceIfPresent

requireIssueDetailsResources

requireQuickEditResources

requireIssueShortcuts

filterInvisibleProjects

searchQuery

searchQuery

searchAndSortQuery

searchAndSortQuery

searchAndSortQuery

matchIssues

matchIssuesSorted

matchIssuesSorted

validateQuery

getConfigurationScopeQuery

getI18n

getI18n

getStructureComparator

getCollator

getLocale

clearAllCaches

clearAllCachesOnAllNodes

clearCurrentUserCaches

clearUserCaches

isStructureLocked

getIssue

getIssue

getConfiguration

instantiate