@PublicApi public class

ManagedConfigurationItem

extends Object
java.lang.Object
   ↳ com.atlassian.jira.config.managedconfiguration.ManagedConfigurationItem

@PublicApi

This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Represents a configuration item in JIRA (an instance of a CustomField, a JiraWorkflow, etc.) which is being managed by a plugin or JIRA itself.

Summary

Public Methods
boolean equals(Object obj)
@Nonnull ConfigurationItemAccessLevel getConfigurationItemAccessLevel()
String getDescriptionI18nKey()
Long getId()
String getItemId()
ManagedConfigurationItemType getItemType()
String getSourceId()
int hashCode()
boolean isManaged()
@Nonnull ManagedConfigurationItemBuilder newBuilder()
Use this method to get a ManagedConfigurationItemBuilder instance, prepopulated with this item's properties.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public boolean equals (Object obj)

@Nonnull public ConfigurationItemAccessLevel getConfigurationItemAccessLevel ()

Returns
  • which users are allowed to edit this managed item. If isManaged() is false, this will return ADMIN.

public String getDescriptionI18nKey ()

Returns
  • the I18n key which describes why this item is being managed

public Long getId ()

Returns

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.)

public ManagedConfigurationItemType getItemType ()

Returns
  • the type of item which is being managed

public String getSourceId ()

Returns
  • who owns/manages this item

public int hashCode ()

public boolean isManaged ()

Returns
  • is this item currently being managed?

@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

public String toString ()