@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.
Modifier and Type | Method and Description |
---|---|
StructureAttributeService |
getAttributeService()
Returns the service that is used to calculate and get field values and other attributes for items.
|
AttributeSubscriptionService |
getAttributeSubscriptionService()
Returns the service that is used to manage subscriptions to attributes.
|
StructureBackupManager |
getBackupManager()
Returns the component that's used to back up and restore Structure data.
|
EffectorInstanceManager |
getEffectorInstanceManager()
Returns a service responsible for CRUD operations on persistent
effector instances |
EffectorProcessManager |
getEffectorProcessManager()
Returns a service that manages
Effector preview, effect application, and undo background processes. |
StructureFavoriteManager |
getFavoriteManager()
Returns the component that's used to access and manage "favorite" relations between users and structures.
|
FolderManager |
getFolderManager()
Returns a service responsible for storing and retrieving folders.
|
ForestService |
getForestService()
Returns a service that lets you retrieve
ForestSource for a structure or a given ForestSpec . |
GeneratorManager |
getGeneratorManager()
Returns the service responsible for storing and retrieving generator instances.
|
IssueEventBridge |
getIssueEventBridge()
Returns the component that's used to listen and report issue events.
|
ItemResolver |
getItemResolver()
Returns a service that resolves
ItemIdentity into an object that represents that item. |
ItemTracker |
getItemTracker()
Returns a service that tracks item updates throughout the system and also allows reporting updates.
|
StructureJobManager |
getJobManager()
Returns the component that's used to run asynchronous jobs.
|
ProcessHandleManager |
getProcessHandleManager()
Returns component that tracks long-running background processes and shows progress to the user.
|
RowManager |
getRowManager()
Returns row manager, which is responsible for managing a mapping between numeric row IDs and item IDs.
|
ScheduledJobManager |
getScheduledJobManager()
Returns the component that is used to schedule recurring asynchronous jobs.
|
StructureConfiguration |
getStructureConfiguration()
Returns the component that's used to manage Structure add-on configuration.
|
StructureManager |
getStructureManager()
Returns the component that's used to manage structures.
|
StructurePropertyService |
getStructurePropertyService()
Returns a service that lets you associate arbitrary properties with a structure.
|
StructureQueryBuilderFactory |
getStructureQueryBuilderFactory()
Returns the component that is used to create new instances of Structure query builders.
|
StructureQueryParser |
getStructureQueryParser()
Returns the component that is used to create Structure queries by parsing them from a String.
|
SyncAuditLog |
getSyncAuditLog()
Returns the component that synchronizers use to store audit information about their execution and actions
they've taken.
|
StructureSyncManager |
getSyncManager()
Returns the component that's used to create and update synchronizers.
|
StructureViewManager |
getViewManager()
Returns the component that's used to work with Structure views.
|
@NotNull StructureManager getStructureManager()
@NotNull ForestService getForestService()
ForestSource
for a structure or a given ForestSpec
.@NotNull StructureAttributeService getAttributeService()
@NotNull AttributeSubscriptionService getAttributeSubscriptionService()
@NotNull StructureConfiguration getStructureConfiguration()
@NotNull StructureSyncManager getSyncManager()
@NotNull StructureBackupManager getBackupManager()
@NotNull StructureJobManager getJobManager()
@NotNull ScheduledJobManager getScheduledJobManager()
@NotNull IssueEventBridge getIssueEventBridge()
@NotNull StructureViewManager getViewManager()
@NotNull StructureFavoriteManager getFavoriteManager()
@NotNull StructureQueryParser getStructureQueryParser()
@NotNull StructureQueryBuilderFactory getStructureQueryBuilderFactory()
@NotNull ProcessHandleManager getProcessHandleManager()
@NotNull RowManager getRowManager()
@NotNull SyncAuditLog getSyncAuditLog()
@NotNull GeneratorManager getGeneratorManager()
@NotNull ItemResolver getItemResolver()
ItemIdentity
into an object that represents that item.@NotNull FolderManager getFolderManager()
@NotNull StructurePropertyService getStructurePropertyService()
@NotNull ItemTracker getItemTracker()
@NotNull EffectorInstanceManager getEffectorInstanceManager()
effector instances
@NotNull EffectorProcessManager getEffectorProcessManager()
Effector
preview, effect application, and undo background processes.Copyright © 2023 ALM Works. All Rights Reserved.