ProjectPropertyService

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

The service used to add, update, retrieve and delete properties from Project's. Each method of this service ensures that the user has permission to perform the operation. For each operation an appropriate event is published.

Summary

[Expand] Inherited Methods
From interface com.atlassian.jira.entity.property.EntityPropertyService void deleteProperty(ApplicationUser user, EntityPropertyService.DeletePropertyValidationResult validationResult) Removes the entity property with specified entity's id and entity's property key. PropertyKeys<T> getPropertiesKeys(ApplicationUser user, Long entityId, EntityPropertyOptions options) Returns the properties keys associated with the specified entity. PropertyKeys<T> getPropertiesKeys(ApplicationUser user, Long entityId) Returns the properties keys associated with the specified entity. EntityPropertyService.PropertyResult getProperty(ApplicationUser user, Long entityId, String propertyKey) Returns the JSON property with the specified key from specified entity. EntityPropertyService.PropertyResult getProperty(ApplicationUser user, Long entityId, String propertyKey, EntityPropertyOptions options) Returns the JSON property with the specified key from specified entity. EntityPropertyService.PropertyResult setProperty(ApplicationUser user, EntityPropertyService.SetPropertyValidationResult propertyValidationResult) Associates validated property with the entity. EntityPropertyService.DeletePropertyValidationResult validateDeleteProperty(ApplicationUser user, Long entityId, String propertyKey, EntityPropertyOptions options) Check if it is possible to remove the entity property with specified entity's id and entity's property key. EntityPropertyService.DeletePropertyValidationResult validateDeleteProperty(ApplicationUser user, Long entityId, String propertyKey) Check if it is possible to remove the entity property with specified entity's id and entity's property key. ErrorCollection validatePropertyInput(EntityPropertyService.PropertyInput propertyInput) Validates the property's key and property's value without permission checking. EntityPropertyService.SetPropertyValidationResult validateSetProperty(ApplicationUser user, Long entityId, EntityPropertyService.PropertyInput propertyInput, EntityPropertyOptions options) Checks if the provided entity's property is valid. EntityPropertyService.SetPropertyValidationResult validateSetProperty(ApplicationUser user, Long entityId, EntityPropertyService.PropertyInput propertyInput) Checks if the provided entity's property is valid.
From interface com.atlassian.jira.entity.property.EntityWithKeyPropertyService PropertyKeys<T> getPropertiesKeys(ApplicationUser user, String entityKey, EntityPropertyOptions options) Returns the properties keys associated with the specified entity. PropertyKeys<T> getPropertiesKeys(ApplicationUser user, String entityKey) Returns the properties keys associated with the specified entity. EntityPropertyService.PropertyResult getProperty(ApplicationUser user, String entityKey, String propertyKey, EntityPropertyOptions options) Returns the JSON property with the specified key from specified entity. EntityPropertyService.PropertyResult getProperty(ApplicationUser user, String entityKey, String propertyKey) Returns the JSON property with the specified key from specified entity. EntityPropertyService.DeletePropertyValidationResult validateDeleteProperty(ApplicationUser user, String entityKey, String propertyKey) Check if it is possible to remove the entity property with specified entity's key and entity's property key. EntityPropertyService.DeletePropertyValidationResult validateDeleteProperty(ApplicationUser user, String entityKey, String propertyKey, EntityPropertyOptions options) Check if it is possible to remove the entity property with specified entity's key and entity's property key. EntityPropertyService.SetPropertyValidationResult validateSetProperty(ApplicationUser user, String entityKey, EntityPropertyService.PropertyInput propertyInput) Checks if the provided entity's property is valid. EntityPropertyService.SetPropertyValidationResult validateSetProperty(ApplicationUser user, String entityKey, EntityPropertyService.PropertyInput propertyInput, EntityPropertyOptions options) Checks if the provided entity's property is valid.