Package com.almworks.jira.structure.api

package com.almworks.jira.structure.api

This package and subpackages contain Structure API, which can be used to integrate with and extend Structure add-on for JIRA.

The packages contains different types of classes:

• To use Structure, make calls to API classes, marked with PublicApi.
• To extend Structure's functionality, extend SPI classes, marked with PublicSpi.
• There are classes marked Internal — you can use those, but backwards compatibility is not guaranteed in minor updates.

You can read more about versioning and the distinction between the API, SPI and Internal classes in Structure Developer's Guide.

All main services are available as injectable parameters or through StructureComponents.

The following is the list of major services you might need to work with:

• StructureManager lets you create, find, update and delete structures. Note that it does not provide access to the structures' content, only to the properties like name and description.
• ForestService allows you to retrieve and update a structure's content. It also can be used to transform structures or to run queries.
• FolderManager and GeneratorManager let you create and manage folders and generators.
• Use CoreIdentities to create ItemIdentity instances for issues and other well-known types.
• RowManager lets you retrieve StructureRow by row ID and extract item ID from it.
• Use StructureSyncManager to install and configure synchronizers.
• Use StructureViewManager to work with views.

Interfaces

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