Package com.atlassian.jira.config.managedconfiguration

Class ManagedConfigurationItem

java.lang.Object
com.atlassian.jira.config.managedconfiguration.ManagedConfigurationItem
@PublicApi public class ManagedConfigurationItem extends Object
Represents a configuration item in JIRA (an instance of a CustomField, a JiraWorkflow, etc.) which is being managed by a plugin or JIRA itself.
Since:
v5.2

  • Method Details

    • getId

      public Long getId()
      Returns:
      The unique ID of this ManagedConfigurationItem

    • getItemId

      public String getItemId()
      Returns:
      the ID of the item that is being managed. For different ManagedConfigurationItemType this can be different things (e.g. workflow name, custom field ID, etc.)

    • getItemType

      public ManagedConfigurationItemType getItemType()
      Returns:
      the type of item which is being managed

    • isManaged

      public boolean isManaged()
      Returns:
      is this item currently being managed?

    • getConfigurationItemAccessLevel

      @Nonnull public ConfigurationItemAccessLevel getConfigurationItemAccessLevel()
      Returns:
      which users are allowed to edit this managed item. If isManaged() is false, this will return ConfigurationItemAccessLevel.ADMIN.

    • getSourceId

      public String getSourceId()
      Returns:
      who owns/manages this item

    • getDescriptionI18nKey

      public String getDescriptionI18nKey()
      Returns:
      the I18n key which describes why this item is being managed

    • newBuilder

      @Nonnull public ManagedConfigurationItemBuilder newBuilder()
      Use this method to get a ManagedConfigurationItemBuilder instance, prepopulated with this item's properties. From there you can make modifications as necessary to alter the configuration.
      Returns:
      the builder instance

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object