@PublicApi public interface

EntityPropertyHelper

com.atlassian.jira.entity.property.EntityPropertyHelper<E extends com.atlassian.jira.entity.WithId>
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

The implementations of this interface are defining permission checking, persistence layer and events for entities E which are identifiable by id. These implementations can be used with are required to provide functions specializing EntityPropertyService.

Summary

Nested Classes
interface EntityPropertyHelper.CheckPermissionFunction<E extends WithId> The base function for checking of permissions on chosen entities. 
Public Methods
BiFunction<ApplicationUser, EntityProperty, ? extends EntityPropertyDeletedEvent> createDeletePropertyEventBiFunction()
@Deprecated Function2<ApplicationUser, EntityProperty, ? extends EntityPropertyDeletedEvent> createDeletePropertyEventFunction()
This method is deprecated. In 7.0.0 Function2 has been deprecated in favour of BiFunction. Use createDeletePropertyEventBiFunction() instead.
BiFunction<ApplicationUser, EntityProperty, ? extends EntityPropertySetEvent> createSetPropertyEventBiFunction()
@Deprecated Function2<ApplicationUser, EntityProperty, ? extends EntityPropertySetEvent> createSetPropertyEventFunction()
This method is deprecated. In 7.0.0 Function2 has been deprecated in favour of BiFunction. Use createSetPropertyEventBiFunction() instead.
Function<Long, Option<E>> getEntityByIdFunction()
EntityPropertyType getEntityPropertyType()
CheckPermissionFunction<E> hasEditPermissionFunction()
CheckPermissionFunction<E> hasReadPermissionFunction()

Public Methods

public BiFunction<ApplicationUser, EntityProperty, ? extends EntityPropertyDeletedEvent> createDeletePropertyEventBiFunction ()

Returns

@Deprecated public Function2<ApplicationUser, EntityProperty, ? extends EntityPropertyDeletedEvent> createDeletePropertyEventFunction ()

This method is deprecated.
In 7.0.0 Function2 has been deprecated in favour of BiFunction. Use createDeletePropertyEventBiFunction() instead.

Returns

public BiFunction<ApplicationUser, EntityProperty, ? extends EntityPropertySetEvent> createSetPropertyEventBiFunction ()

Returns

@Deprecated public Function2<ApplicationUser, EntityProperty, ? extends EntityPropertySetEvent> createSetPropertyEventFunction ()

This method is deprecated.
In 7.0.0 Function2 has been deprecated in favour of BiFunction. Use createSetPropertyEventBiFunction() instead.

Returns

public Function<Long, Option<E>> getEntityByIdFunction ()

Returns
  • the function which will get the entity for the provided id.

public EntityPropertyType getEntityPropertyType ()

Returns
  • the type of the entity property.

public CheckPermissionFunction<E> hasEditPermissionFunction ()

Returns
  • the function which will check if the provided user has permissions to edit the entity.

public CheckPermissionFunction<E> hasReadPermissionFunction ()

Returns
  • the function which will check if the provided user has permissions to view the entity.