com.atlassian.jira.entity.property
Class BaseEntityWithKeyPropertyService<E extends WithKey & WithId>

java.lang.Object
  com.atlassian.jira.entity.property.BaseEntityPropertyService<E>
      com.atlassian.jira.entity.property.BaseEntityWithKeyPropertyService<E>

All Implemented Interfaces:

EntityPropertyService<E>, EntityWithKeyPropertyService<E>

@ExperimentalApi
public class BaseEntityWithKeyPropertyService<E extends WithKey & WithId>
extends BaseEntityPropertyService<E>
implements EntityWithKeyPropertyService<E>

The base implementation of EntityWithKeyPropertyService. This should be used for entities which are identifiable by both: key and id, such as Issue.

Since:

v6.2

See Also:

BaseEntityPropertyService

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.entity.property.EntityPropertyService

EntityPropertyService.DeletePropertyValidationResult, EntityPropertyService.EntityPropertyInput, EntityPropertyService.PropertyInput, EntityPropertyService.PropertyKeys<E>, EntityPropertyService.PropertyResult, EntityPropertyService.PropertyServiceResult, EntityPropertyService.SetPropertyValidationResult

Constructor Summary

BaseEntityWithKeyPropertyService(JsonEntityPropertyManager jsonEntityPropertyManager, I18nHelper i18n, com.atlassian.event.api.EventPublisher eventPublisher, EntityWithKeyPropertyHelper<E> entityHelper)

Method Summary

EntityPropertyService.PropertyKeys<E>	getPropertiesKeys(ApplicationUser user, String entityKey) Returns the properties keys associated with the 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.SetPropertyValidationResult	validateSetProperty(ApplicationUser user, String entityKey, EntityPropertyService.PropertyInput propertyInput) Checks if the provided entity's property is valid.

Methods inherited from class com.atlassian.jira.entity.property.BaseEntityPropertyService

deleteProperty, getPropertiesKeys, getPropertiesKeys, getProperty, getProperty, setProperty, validateDeleteProperty, validateDeleteProperty, validateSetProperty, validateSetProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.jira.entity.property.EntityPropertyService

deleteProperty, getPropertiesKeys, getProperty, setProperty, validateDeleteProperty, validateSetProperty

Constructor Detail

BaseEntityWithKeyPropertyService

public BaseEntityWithKeyPropertyService(JsonEntityPropertyManager jsonEntityPropertyManager,
                                        I18nHelper i18n,
                                        com.atlassian.event.api.EventPublisher eventPublisher,
                                        EntityWithKeyPropertyHelper<E> entityHelper)

Method Detail

validateSetProperty

public EntityPropertyService.SetPropertyValidationResult validateSetProperty(ApplicationUser user,
                                                                             String entityKey,
                                                                             EntityPropertyService.PropertyInput propertyInput)

Description copied from interface: EntityWithKeyPropertyService

Checks if the provided entity's property is valid.

This method checks if the entity with which the property will be associated exists and if the calling user has permissions to edit the entity. It validates if the property's key length is less then 255 characters. It also checks if the length of the property's value is less then 32,768.

Specified by:

validateSetProperty in interface EntityWithKeyPropertyService<E extends WithKey & WithId>

Parameters:

user - who the permission checks will be run against (can be null, indicating anonymous user).

entityKey - the key of the entity with which the property will be associated.

propertyInput - the pair of key and value which will be associated with the entity.

Returns:

either entity ready to be persisted in DB or collection of errors.

validateDeleteProperty

public EntityPropertyService.DeletePropertyValidationResult validateDeleteProperty(ApplicationUser user,
                                                                                   String entityKey,
                                                                                   String propertyKey)

Description copied from interface: EntityWithKeyPropertyService

Check if it is possible to remove the entity property with specified entity's key and entity's property key.

This method checks if the calling user has permissions to edit the selected entity and if the property for given entity key and property key exists.

Specified by:

validateDeleteProperty in interface EntityWithKeyPropertyService<E extends WithKey & WithId>

Parameters:

user - who the permission checks will be run against (can be null, indicating anonymous user).

entityKey - the key of the entity with which the property is associated.

propertyKey - the key of the entity's property.

Returns:

either entity ready to be removed or collection of errors.

getProperty

public EntityPropertyService.PropertyResult getProperty(ApplicationUser user,
                                                        String entityKey,
                                                        String propertyKey)

Description copied from interface: EntityWithKeyPropertyService

Returns the JSON property with the specified key from specified entity.

This method checks if the calling user has permissions to browse the entitys and if the entity with given key exists.

Specified by:

getProperty in interface EntityWithKeyPropertyService<E extends WithKey & WithId>

Parameters:

user - who the permission checks will be run against (can be null, indicating anonymous user).

entityKey - the key of the entity with which the property is associated.

propertyKey - the key of the entity's property.

Returns:

the chosen property of the entity if found or the error collection.

getPropertiesKeys

public EntityPropertyService.PropertyKeys<E> getPropertiesKeys(ApplicationUser user,
                                                               String entityKey)

Description copied from interface: EntityWithKeyPropertyService

Returns the properties keys associated with the specified entity.

This method checks if the calling user has permissions to browse the entitys and if the entity with given id exists.

Specified by:

getPropertiesKeys in interface EntityWithKeyPropertyService<E extends WithKey & WithId>

Parameters:

user - who the permission checks will be run against (can be null, indicating anonymous user).

entityKey - the key of the entity with which the property is associated.

Returns:

the list of properties keys and associated entity or a collection with errors.