Package com.atlassian.jira.entity.property

Interface EntityPropertyHelper<E extends WithId>

Type Parameters:

E - - entity type which extends WithId interface.

All Known Subinterfaces:

EntityWithKeyPropertyHelper<E>

All Known Implementing Classes:

ChangeHistoryPropertyHelper, CommentPropertyHelper, DashboardItemPropertyHelper, IssuePropertyHelper, IssueTypePropertyHelper, ProjectPropertyHelper, UserPropertyHelper

@PublicApi
public interface EntityPropertyHelper<E extends WithId>

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

Since:

v6.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityPropertyHelper.CheckPermissionFunction<E extends WithId>	The base function for checking of permissions on chosen entities.

Method Summary

Modifier and Type	Method	Description
BiFunction<ApplicationUser,EntityProperty,? extends EntityPropertyDeletedEvent>	createDeletePropertyEventBiFunction()
BiFunction<ApplicationUser,EntityProperty,? extends EntityPropertySetEvent>	createSetPropertyEventBiFunction()
Function<Long,io.atlassian.fugue.Option<E>>	getEntityByIdFunction()
EntityPropertyType	getEntityPropertyType()
EntityPropertyHelper.CheckPermissionFunction<E>	hasEditPermissionFunction()
EntityPropertyHelper.CheckPermissionFunction<E>	hasReadPermissionFunction()

Method Details

hasEditPermissionFunction

EntityPropertyHelper.CheckPermissionFunction<E> hasEditPermissionFunction()

Returns:

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

hasReadPermissionFunction

EntityPropertyHelper.CheckPermissionFunction<E> hasReadPermissionFunction()

Returns:

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

getEntityByIdFunction

Function<Long,io.atlassian.fugue.Option<E>> getEntityByIdFunction()

Returns:

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

createSetPropertyEventBiFunction

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

Returns:

the function which will create an instance of EntityPropertySetEvent for the proper entity type.

Since:

7.0.0

createDeletePropertyEventBiFunction

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

Returns:

the function which will create an instance of EntityPropertyDeletedEvent for the proper entity type.

Since:

7.0.0

getEntityPropertyType

EntityPropertyType getEntityPropertyType()

Returns:

the type of the entity property.