com.atlassian.jira.entity.property

Class AbstractEntityPropertyConditionHelper<T extends WithId>

java.lang.Object

com.atlassian.jira.entity.property.AbstractEntityPropertyConditionHelper<T>

Type Parameters:

T - - the type of entity

All Implemented Interfaces:

EntityPropertyConditionHelper

Direct Known Subclasses:

CommentPropertyConditionHelper, DashboardItemPropertyConditionHelper, IssuePropertyConditionHelper, IssueTypePropertyConditionHelper, ProjectPropertyConditionHelper, UserPropertyConditionHelper

@PublicApi
public abstract class AbstractEntityPropertyConditionHelper<T extends WithId>
extends Object
implements EntityPropertyConditionHelper

Base class for entity property conditions.

Since:

v7.1

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEntityPropertyConditionHelper(EntityPropertyService<T> propertyService, Class<T> propertyEntityType, String entityName)

Method Summary

Modifier and Type	Method and Description
Optional<Long>	getEntityId(JiraWebContext context) This implementation expects to find the entity of the class T in the context by the "entityName" key.
String	getEntityName()
EntityPropertyService.PropertyResult	getProperty(ApplicationUser user, Long entityId, String propertyKey) Returns the entity property for the given and .

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractEntityPropertyConditionHelper

protected AbstractEntityPropertyConditionHelper(EntityPropertyService<T> propertyService,
                                                Class<T> propertyEntityType,
                                                String entityName)

Method Detail

getEntityId

public Optional<Long> getEntityId(JiraWebContext context)

This implementation expects to find the entity of the class T in the context by the "entityName" key. ID is then taken directly from this entity.

Specified by:

getEntityId in interface EntityPropertyConditionHelper

Parameters:

context - - context of the web element for which the condition is evaluated.

Returns:

ID of the entity taken from context or empty.

getEntityName

public final String getEntityName()

Specified by:

getEntityName in interface EntityPropertyConditionHelper

Returns:

the name of the entity.

getProperty

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

Description copied from interface: EntityPropertyConditionHelper

Returns the entity property for the given and .

Specified by:

getProperty in interface EntityPropertyConditionHelper

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.