@ExperimentalApi public interface EntityWithKeyPropertyService<T extends WithId & WithKey> extends EntityPropertyService<T>
EntityPropertyService
specific for entities which are identifiable by key.BaseEntityWithKeyPropertyService
EntityPropertyService.DeletePropertyValidationResult, EntityPropertyService.EntityPropertyInput, EntityPropertyService.PropertyInput, EntityPropertyService.PropertyKeys<E>, EntityPropertyService.PropertyResult, EntityPropertyService.PropertyServiceResult, EntityPropertyService.SetPropertyValidationResult
Modifier and Type | Method and Description |
---|---|
EntityPropertyService.PropertyKeys<T> |
getPropertiesKeys(ApplicationUser user,
String entityKey)
Returns the properties keys associated with the specified entity.
|
EntityPropertyService.PropertyKeys<T> |
getPropertiesKeys(ApplicationUser user,
String entityKey,
EntityPropertyOptions options)
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.PropertyResult |
getProperty(ApplicationUser user,
String entityKey,
String propertyKey,
EntityPropertyOptions options)
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.
|
deleteProperty, getProperties, getProperties, getPropertiesKeys, getPropertiesKeys, getProperty, getProperty, setProperty, validateDeleteProperty, validateDeleteProperty, validatePropertyInput, validateSetProperty, validateSetProperty
EntityPropertyService.SetPropertyValidationResult validateSetProperty(ApplicationUser user, @Nonnull String entityKey, @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).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.EntityPropertyService.SetPropertyValidationResult validateSetProperty(ApplicationUser user, @Nonnull String entityKey, @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).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.options
- options to skip permission while performing the validation.EntityPropertyService.DeletePropertyValidationResult validateDeleteProperty(ApplicationUser user, @Nonnull String entityKey, @Nonnull String propertyKey)
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.
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.EntityPropertyService.DeletePropertyValidationResult validateDeleteProperty(ApplicationUser user, @Nonnull String entityKey, @Nonnull String propertyKey, @Nonnull EntityPropertyOptions options)
This method checks if the property for given entity key and property key exists.
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.options
- options to skip permission while performing the validation.EntityPropertyService.PropertyResult getProperty(ApplicationUser user, @Nonnull String entityKey, @Nonnull String propertyKey)
This method checks if the calling user has permissions to browse the entities and if the entity with given key exists.
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.EntityPropertyService.PropertyResult getProperty(ApplicationUser user, @Nonnull String entityKey, @Nonnull String propertyKey, @Nonnull EntityPropertyOptions options)
This method checks if the entity with given key exists.
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.options
- options to skip permission while performing the validation.EntityPropertyService.PropertyKeys<T> getPropertiesKeys(ApplicationUser user, @Nonnull String entityKey)
This method checks if the calling user has permissions to browse the entitys and if the entity with given id exists.
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.EntityPropertyService.PropertyKeys<T> getPropertiesKeys(ApplicationUser user, @Nonnull String entityKey, @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).entityKey
- the key of the entity with which the property is associated.options
- options to skip permission while performing the validation.Copyright © 2002-2019 Atlassian. All Rights Reserved.