com.almworks.jira.structure.api
Interface StructureServices

public interface StructureServices

StructureServices is a convenience interface that can be used to retrieve all public services of the Structure plugin. You can also get those services from ComponentAccessor or by declaring them in a constructor of your component and have them injected.

The convenience is in reducing the number of parameters you declare in the constructor of your component.

Note that this service returns the original instances of those services, unlike when the proxies for the services are injected.

This class also provides some frequently-used Atlassian interfaces.

Author:

Igor Sereda

Method Summary

com.atlassian.jira.security.JiraAuthenticationContext	getAuthenticationContext()
StructureBackupManager	getBackupManager()
StructureFavoriteManager	getFavoriteManager()
IssueEventBridge	getIssueEventBridge()
com.atlassian.jira.issue.IssueManager	getIssueManager()
StructureJobManager	getJobManager()
ProgressCalculator	getProgressCalculator()
StructureConfiguration	getStructureConfiguration()
StructureManager	getStructureManager()
StructureQueryBuilderFactory	getStructureQueryBuilderFactory()
StructureQueryParser	getStructureQueryParser()
SynchronizerUndoRecorder	getSynchronizerUndoRecorder()
StructureSyncManager	getSyncManager()
StructureViewManager	getViewManager()

Method Detail

getStructureManager

@NotNull
StructureManager getStructureManager()

Returns:

component that's used to work with structures and forests

getStructureConfiguration

@NotNull
StructureConfiguration getStructureConfiguration()

Returns:

component that's used to manage structure configuration

getProgressCalculator

@NotNull
ProgressCalculator getProgressCalculator()

Returns:

component that's used to calculate issue progress

getSyncManager

@NotNull
StructureSyncManager getSyncManager()

Returns:

component that's used to work with synchronizers

getBackupManager

@NotNull
StructureBackupManager getBackupManager()

Returns:

component that's used to back up and restore structure

getJobManager

@NotNull
StructureJobManager getJobManager()

Returns:

component that's used to schedule asynchronous jobs

getIssueEventBridge

@NotNull
IssueEventBridge getIssueEventBridge()

Returns:

component that's used to listen and report issue events

getSynchronizerUndoRecorder

@NotNull
SynchronizerUndoRecorder getSynchronizerUndoRecorder()

Returns:

component that's used by the synchronizers to store undo information

getViewManager

@NotNull
StructureViewManager getViewManager()

Returns:

component that's used to work with structure views

Since:

7.2.0 (Structure 2.0)

getFavoriteManager

@NotNull
StructureFavoriteManager getFavoriteManager()

Returns:

component that's used to access and manage "favorite" relations between users and structures.

Since:

7.2.0 (Structure 2.0)

getStructureQueryParser

@NotNull
StructureQueryParser getStructureQueryParser()

Returns:

component that is used to create Structure queries by parsing them from a String.

Since:

8.1.0 (Structure 2.4)

getStructureQueryBuilderFactory

@NotNull
StructureQueryBuilderFactory getStructureQueryBuilderFactory()

Returns:

component that is used to create new instances of Structure query builders.

Since:

8.1.0 (Structure 2.4)

getAuthenticationContext

@NotNull
com.atlassian.jira.security.JiraAuthenticationContext getAuthenticationContext()

Returns:

JIRA component that's used to get the current user

getIssueManager

@NotNull
com.atlassian.jira.issue.IssueManager getIssueManager()

Returns:

JIRA component that's used to work with issues