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, ProjectPropertyHelper

@ExperimentalApi
public interface EntityPropertyHelper<E extends WithId>

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.

Since:

v6.2

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
com.atlassian.fugue.Function2<ApplicationUser,EntityProperty,? extends EntityPropertyDeletedEvent>	createDeletePropertyEventFunction()
com.atlassian.fugue.Function2<ApplicationUser,EntityProperty,? extends EntityPropertySetEvent>	createSetPropertyEventFunction()
com.google.common.base.Function<Long,com.atlassian.fugue.Option<E>>	getEntityByIdFunction()
EntityPropertyType	getEntityPropertyType()
EntityPropertyHelper.CheckPermissionFunction<E>	hasEditPermissionFunction()
EntityPropertyHelper.CheckPermissionFunction<E>	hasReadPermissionFunction()

Method Detail

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

com.google.common.base.Function<Long,com.atlassian.fugue.Option<E>> getEntityByIdFunction()

Returns:

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

createSetPropertyEventFunction

com.atlassian.fugue.Function2<ApplicationUser,EntityProperty,? extends EntityPropertySetEvent> createSetPropertyEventFunction()

Returns:

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

createDeletePropertyEventFunction

com.atlassian.fugue.Function2<ApplicationUser,EntityProperty,? extends EntityPropertyDeletedEvent> createDeletePropertyEventFunction()

Returns:

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

getEntityPropertyType

EntityPropertyType getEntityPropertyType()

Returns:

the type of the entity property.