@PublicApi
public interface EntityPropertyService<T extends WithId>
BaseEntityPropertyService
Modifier and Type | Interface and Description |
---|---|
static class |
EntityPropertyService.DeletePropertyValidationResult |
static class |
EntityPropertyService.EntityPropertyInput
Tuple with property value, property key, entity id and entity name, which will be persisted by the service.
|
static class |
EntityPropertyService.PropertyInput
The key-value pair associated to the entity.
|
static class |
EntityPropertyService.PropertyKeys<E> |
static class |
EntityPropertyService.PropertyResult |
static class |
EntityPropertyService.PropertyServiceResult |
static class |
EntityPropertyService.SetPropertyValidationResult |
Modifier and Type | Method and Description |
---|---|
void |
deleteProperty(ApplicationUser user,
EntityPropertyService.DeletePropertyValidationResult validationResult)
Removes the entity property with specified entity's id and entity's property key.
|
List<EntityProperty> |
getProperties(ApplicationUser user,
Long entityId)
Returns all properties.
|
List<EntityProperty> |
getProperties(ApplicationUser user,
Long entityId,
List<String> propertyKeys)
Returns properties with specified keys.
|
EntityPropertyService.PropertyKeys<T> |
getPropertiesKeys(ApplicationUser user,
Long entityId)
Returns the properties keys associated with the specified entity.
|
EntityPropertyService.PropertyKeys<T> |
getPropertiesKeys(ApplicationUser user,
Long entityId,
EntityPropertyOptions options)
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 |
getProperty(ApplicationUser user,
T entity,
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)
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,
EntityPropertyOptions options)
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)
Checks if the provided entity's property is valid.
|
EntityPropertyService.SetPropertyValidationResult |
validateSetProperty(ApplicationUser user,
Long entityId,
EntityPropertyService.PropertyInput propertyInput,
EntityPropertyOptions options)
Checks if the provided entity's property is valid.
|
ErrorCollection validatePropertyInput(EntityPropertyService.PropertyInput propertyInput)
propertyInput
- the key and value of the property.EntityPropertyService.SetPropertyValidationResult validateSetProperty(ApplicationUser user, @Nonnull Long entityId, @Nonnull EntityPropertyService.PropertyInput propertyInput)
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
.
user
- who the permission checks will be run against (can be null, indicating anonymous user).entityId
- the id of the entity with which the property will be associated.propertyInput
- the pair of key and value which will be associated with the entity.EntityPropertyService.SetPropertyValidationResult validateSetProperty(ApplicationUser user, @Nonnull Long entityId, @Nonnull EntityPropertyService.PropertyInput propertyInput, @Nonnull EntityPropertyOptions options)
This method checks if the entity with which the property will be associated exists.
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
.
user
- who the permission checks will be run against (can be null, indicating anonymous user).entityId
- the id of the entity with which the property will be associated.propertyInput
- the pair of key and value which will be associated with the entity.options
- options to skip permission while performing the validation.EntityPropertyService.PropertyResult setProperty(ApplicationUser user, @Nonnull EntityPropertyService.SetPropertyValidationResult propertyValidationResult)
EntityPropertySetEvent
is published.user
- who the permission checks will be run against (can be null, indicating anonymous user).propertyValidationResult
- validated entity property.EntityPropertyService.DeletePropertyValidationResult validateDeleteProperty(ApplicationUser user, @Nonnull Long entityId, @Nonnull String propertyKey)
This method checks if the calling user has permissions to edit the selected entity and if the property for given entity id and property key exists.
user
- who the permission checks will be run against (can be null, indicating anonymous user).entityId
- the id of the entity with which the property is associated.propertyKey
- the key of the entity's property.EntityPropertyService.DeletePropertyValidationResult validateDeleteProperty(ApplicationUser user, @Nonnull Long entityId, @Nonnull String propertyKey, @Nonnull EntityPropertyOptions options)
This method checks if the property for given entity id and property key exists.
user
- who the permission checks will be run against (can be null, indicating anonymous user).entityId
- the id of the entity with which the property is associated.propertyKey
- the key of the entity's property.options
- options to skip permission while performing the validation.void deleteProperty(ApplicationUser user, @Nonnull EntityPropertyService.DeletePropertyValidationResult validationResult)
EntityPropertyDeletedEvent
is published.user
- who the permission checks will be run against (can be null, indicating anonymous user).validationResult
- validation results of entity's property removal.EntityPropertyService.PropertyResult getProperty(ApplicationUser user, @Nonnull Long entityId, @Nonnull String propertyKey)
This method checks if the calling user has permissions to browse the entities and if the entity with given id exists.
user
- who the permission checks will be run against (can be null, indicating anonymous user).entityId
- the id of the entity with which the property is associated.propertyKey
- the key of the entity's property.EntityPropertyService.PropertyResult getProperty(ApplicationUser user, @Nonnull Long entityId, @Nonnull String propertyKey, @Nonnull EntityPropertyOptions options)
This method checks if the entity with given id exists.
user
- who the permission checks will be run against (can be null, indicating anonymous user).entityId
- the id of the entity with which the property is associated.propertyKey
- the key of the entity's property.options
- options to skip permission while performing the validation.EntityPropertyService.PropertyResult getProperty(ApplicationUser user, @Nonnull T entity, @Nonnull String propertyKey, @Nonnull EntityPropertyOptions options)
user
- who the permission checks will be run against (can be null, indicating anonymous user).entity
- the entity with which the property is associated.propertyKey
- the key of the entity's property.options
- options to skip permission while performing the validation.List<EntityProperty> getProperties(ApplicationUser user, Long entityId, List<String> propertyKeys)
user
- who the permission checks will be run against (can be null, indicating anonymous user).entityId
- the id of the entity with which the properties are associated.propertyKeys
- the keys of the requested propertiesList<EntityProperty> getProperties(ApplicationUser user, Long entityId)
user
- who the permission checks will be run against (can be null, indicating anonymous user).entityId
- the id of the entity with which the properties are associated.EntityPropertyService.PropertyKeys<T> getPropertiesKeys(ApplicationUser user, @Nonnull Long entityId)
This method checks if the calling user has permissions to browse the entities and if the entity with given id exists.
user
- who the permission checks will be run against (can be null, indicating anonymous user).entityId
- the id of the entity with which the property is associated.EntityPropertyService.PropertyKeys<T> getPropertiesKeys(ApplicationUser user, @Nonnull Long entityId, @Nonnull EntityPropertyOptions options)
This method checks if the entity with given id exists.
user
- who the permission checks will be run against (can be null, indicating anonymous user).entityId
- the id of the entity with which the property is associated.options
- options to skip permission while performing the validation.Copyright © 2002-2021 Atlassian. All Rights Reserved.