com.atlassian.jira.entity.property

Interface EntityPropertyConditionHelper

All Known Implementing Classes:

AbstractEntityPropertyConditionHelper, CommentPropertyConditionHelper, DashboardItemPropertyConditionHelper, IssuePropertyConditionHelper, IssueTypePropertyConditionHelper, ProjectPropertyConditionHelper, UserPropertyConditionHelper

@PublicApi
public interface EntityPropertyConditionHelper

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

Since:

7.1

Method Summary

Modifier and Type	Method and Description
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 .

Method Detail

getEntityName

String getEntityName()

Returns:

the name of the entity.

getEntityId

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.

getProperty

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.