@PublicApi public interface

EntityPropertyConditionHelper

com.atlassian.jira.entity.property.EntityPropertyConditionHelper
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

Implementations of this interface are supposed to provide methods for retrieving entity and entity's property from context.

Summary

Public Methods
Optional<Long> getEntityId(JiraWebContext context)
Extracts the id of the entity from context.
String getEntityName()
EntityPropertyService.PropertyResult getProperty(ApplicationUser user, Long entityId, String propertyKey)
Returns the entity property for the given and .

Public Methods

public Optional<Long> getEntityId (JiraWebContext context)

Extracts the id of the entity from context.

Parameters
context - context of the web element for which the condition is evaluated. Please note, that does not have a fixed contract.
Returns
  • the id of the element if found in context or empty.

public String getEntityName ()

Returns
  • the name of the entity.

public EntityPropertyService.PropertyResult getProperty (ApplicationUser user, Long entityId, String propertyKey)

Returns the entity property for the given and .

Parameters
user - authenticated user, who retrieves the property.
entityId - id of the entity.
propertyKey - key of the property to retrieve.
Returns
  • the property of invalid if the property does not exist.