Package com.almworks.jira.structure.api

Interface StructureComponents

@PublicApi public interface StructureComponents

StructureComponents is a convenience interface that can be used to retrieve all public services of the Structure plugin (except internal and experimental APIs). 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 Details

    • getStructureManager

      @NotNull StructureManager getStructureManager()
      Returns the component that's used to manage structures.

    • getForestService

      @NotNull ForestService getForestService()
      Returns a service that lets you retrieve ForestSource for a structure or a given ForestSpec.

    • getAttributeService

      @NotNull StructureAttributeService getAttributeService()
      Returns the service that is used to calculate and get field values and other attributes for items.

    • getAttributeSubscriptionService

      @NotNull AttributeSubscriptionService getAttributeSubscriptionService()
      Returns the service that is used to manage subscriptions to attributes. It's an async way to retrieve attributes.

    • getStructureConfiguration

      @NotNull StructureConfiguration getStructureConfiguration()
      Returns the component that's used to manage Structure add-on configuration.

    • getSyncManager

      @NotNull StructureSyncManager getSyncManager()
      Returns the component that's used to create and update synchronizers.

    • getBackupManager

      @NotNull StructureBackupManager getBackupManager()
      Returns the component that's used to back up and restore Structure data.

    • getJobManager

      @NotNull StructureJobManager getJobManager()
      Returns the component that's used to run asynchronous jobs.

    • getScheduledJobManager

      @NotNull ScheduledJobManager getScheduledJobManager()
      Returns the component that is used to schedule recurring asynchronous jobs.

    • getIssueEventBridge

      @NotNull IssueEventBridge getIssueEventBridge()
      Returns the component that's used to listen and report issue events.

    • getViewManager

      @NotNull StructureViewManager getViewManager()
      Returns the component that's used to work with Structure views.

    • getFavoriteManager

      @NotNull StructureFavoriteManager getFavoriteManager()
      Returns the component that's used to access and manage "favorite" relations between users and structures.

    • getStructureQueryParser

      @NotNull StructureQueryParser getStructureQueryParser()
      Returns the component that is used to create Structure queries by parsing them from a String.

    • getStructureQueryBuilderFactory

      @NotNull StructureQueryBuilderFactory getStructureQueryBuilderFactory()
      Returns the component that is used to create new instances of Structure query builders.

    • getProcessHandleManager

      @NotNull ProcessHandleManager getProcessHandleManager()
      Returns component that tracks long-running background processes and shows progress to the user.

    • getRowManager

      @NotNull RowManager getRowManager()
      Returns row manager, which is responsible for managing a mapping between numeric row IDs and item IDs.

    • getSyncAuditLog

      @NotNull SyncAuditLog getSyncAuditLog()
      Returns the component that synchronizers use to store audit information about their execution and actions they've taken.

    • getGeneratorManager

      @NotNull GeneratorManager getGeneratorManager()
      Returns the service responsible for storing and retrieving generator instances.

    • getItemResolver

      @NotNull ItemResolver getItemResolver()
      Returns a service that resolves ItemIdentity into an object that represents that item.

    • getFolderManager

      @NotNull FolderManager getFolderManager()
      Returns a service responsible for storing and retrieving folders.

    • getStructurePropertyService

      @NotNull StructurePropertyService getStructurePropertyService()
      Returns a service that lets you associate arbitrary properties with a structure.

    • getItemTracker

      @NotNull ItemTracker getItemTracker()
      Returns a service that tracks item updates throughout the system and also allows reporting updates.

    • getEffectorInstanceManager

      @NotNull EffectorInstanceManager getEffectorInstanceManager()
      Returns a service responsible for CRUD operations on persistent effector instances

    • getEffectorProcessManager

      @NotNull EffectorProcessManager getEffectorProcessManager()
      Returns a service that manages Effector preview, effect application, and undo background processes.