com.atlassian.jira.config.managedconfiguration

Interface ManagedConfigurationItemStore

All Known Implementing Classes:

DefaultManagedConfigurationItemStore

public interface ManagedConfigurationItemStore

Store layer of ManagedConfigurationItemService. Plugin developers should not need to invoke these methods directly.

Since:

v5.2

See Also:

ManagedConfigurationItemService

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteManagedConfigurationItem(ManagedConfigurationItem item) Remove the specified ManagedConfigurationItem.
ManagedConfigurationItem	getManagedConfigurationItem(String itemId, ManagedConfigurationItemType type) Retrieve the ManagedConfigurationItem description of the specified item ID and type.
Collection<ManagedConfigurationItem>	getManagedConfigurationItems(ManagedConfigurationItemType type) Retrieve all the ManagedConfigurationItems of the specified type.
ManagedConfigurationItem	updateManagedConfigurationItem(ManagedConfigurationItem item) Persist the specified ManagedConfigurationItem.

Method Detail

updateManagedConfigurationItem

@Nonnull
ManagedConfigurationItem updateManagedConfigurationItem(@Nonnull
                                                              ManagedConfigurationItem item)

Persist the specified ManagedConfigurationItem.

Parameters:

item - the item

Returns:

the persisted item

Throws:

DataAccessException

deleteManagedConfigurationItem

boolean deleteManagedConfigurationItem(@Nonnull
                                     ManagedConfigurationItem item)

Remove the specified ManagedConfigurationItem.

Parameters:

item - the item

Returns:

true if the item was removed; false otherwise

getManagedConfigurationItem

@Nullable
ManagedConfigurationItem getManagedConfigurationItem(@Nonnull
                                                            String itemId,
                                                            @Nonnull
                                                            ManagedConfigurationItemType type)

Retrieve the ManagedConfigurationItem description of the specified item ID and type.

Parameters:

itemId - the item ID; note that each type describes its IDs individually

type - the type

Returns:

the item if found; null otherwise

getManagedConfigurationItems

@Nonnull
Collection<ManagedConfigurationItem> getManagedConfigurationItems(@Nonnull
                                                                        ManagedConfigurationItemType type)

Retrieve all the ManagedConfigurationItems of the specified type. This includes items which may have been owned by a plugin which is no longer installed.

Parameters:

type - the type

Returns:

the items