net.nemerosa.ontrack.model.structure

Interface PropertyService

All Known Implementing Classes:

PropertyServiceImpl

public interface PropertyService

Management of properties.

Method Summary

Modifier and Type	Method and Description
<T> void	copyProperty(ProjectEntity sourceEntity, Property<T> property, ProjectEntity targetEntity, java.util.function.Function<java.lang.String,java.lang.String> replacementFn) Copy/clones the property into the targetEntity after applying the replacement function.
default <T> Ack	deleteProperty(ProjectEntity entity, java.lang.Class<? extends PropertyType<T>> propertyType) Deletes the value of a property.
Ack	deleteProperty(ProjectEntity entity, java.lang.String propertyTypeName) Deletes the value of a property.
<T> Ack	editProperty(ProjectEntity entity, java.lang.Class<? extends PropertyType<T>> propertyType, T data) Edits the value of a property.
Ack	editProperty(ProjectEntity entity, java.lang.String propertyTypeName, com.fasterxml.jackson.databind.JsonNode data) Edits the value of a property.
<T> ID	findBuildByBranchAndSearchkey(ID branchId, java.lang.Class<? extends PropertyType<T>> propertyType, java.lang.String searchKey) Finds an item using its search key.
java.util.List<Property<?>>	getProperties(ProjectEntity entity) List of property values for a given entity and for the current user.
<T> Property<T>	getProperty(ProjectEntity entity, java.lang.Class<? extends PropertyType<T>> propertyTypeClass) Same than getProperty(ProjectEntity, String) but using the class of the property type.
<T> Property<T>	getProperty(ProjectEntity entity, java.lang.String propertyTypeName) Gets the value for a given property for an entity.
Form	getPropertyEditionForm(ProjectEntity entity, java.lang.String propertyTypeName) Gets the edition form for a given property for an entity.
<T> PropertyType<T>	getPropertyTypeByName(java.lang.String propertyTypeName) Gets a property type using its name
java.util.List<PropertyType<?>>	getPropertyTypes() List of all property types
default <T> boolean	hasProperty(ProjectEntity entity, java.lang.Class<? extends PropertyType<T>> propertyTypeClass) Tests if a property is defined.
<T> java.util.Collection<ProjectEntity>	searchWithPropertyValue(java.lang.Class<? extends PropertyType<T>> propertyTypeClass, java.util.function.BiFunction<ProjectEntityType,ID,ProjectEntity> entityLoader, java.util.function.Predicate<T> predicate) Searches for all entities with the corresponding property value.

Method Detail

getPropertyTypes

java.util.List<PropertyType<?>> getPropertyTypes()

List of all property types

getPropertyTypeByName

<T> PropertyType<T> getPropertyTypeByName(java.lang.String propertyTypeName)

Gets a property type using its name

Type Parameters:

T - Type of property

Parameters:

propertyTypeName - Fully qualified name of the property type

Returns:

Property type

Throws:

PropertyTypeNotFoundException - If not found

getProperties

java.util.List<Property<?>> getProperties(ProjectEntity entity)

List of property values for a given entity and for the current user.

Parameters:

entity - Entity

Returns:

List of properties for this entity

getPropertyEditionForm

Form getPropertyEditionForm(ProjectEntity entity,
                            java.lang.String propertyTypeName)

Gets the edition form for a given property for an entity. The content of the form may be filled or not, according to the fact if the property is actually set for this entity or not. If the property is not opened for edition, the call could be rejected with an authorization exception.

Parameters:

entity - Entity to get the edition form for

propertyTypeName - Fully qualified name of the property to get the form for

Returns:

An edition form to be used by the client

getProperty

<T> Property<T> getProperty(ProjectEntity entity,
                            java.lang.String propertyTypeName)

Gets the value for a given property for an entity. If the property is not set, a non-null Property is returned but is marked as empty. If the property is not opened for viewing, the call could be rejected with an authorization exception.

Parameters:

entity - Entity to get the edition form for

propertyTypeName - Fully qualified name of the property to get the property for

Returns:

A response that defines the property

getProperty

<T> Property<T> getProperty(ProjectEntity entity,
                            java.lang.Class<? extends PropertyType<T>> propertyTypeClass)

Same than getProperty(ProjectEntity, String) but using the class of the property type.

Parameters:

entity - Entity to get the edition form for

propertyTypeClass - Class of the property type to get the property for

Returns:

A response that defines the property

editProperty

Ack editProperty(ProjectEntity entity,
                 java.lang.String propertyTypeName,
                 com.fasterxml.jackson.databind.JsonNode data)

Edits the value of a property.

Parameters:

entity - Entity to edit

propertyTypeName - Fully qualified name of the property to edit

data - Raw JSON data for the property value

editProperty

<T> Ack editProperty(ProjectEntity entity,
                     java.lang.Class<? extends PropertyType<T>> propertyType,
                     T data)

Edits the value of a property.

Parameters:

entity - Entity to edit

propertyType - The type of the property to edit

data - Property value

deleteProperty

Ack deleteProperty(ProjectEntity entity,
                   java.lang.String propertyTypeName)

Deletes the value of a property.

Parameters:

entity - Type of the entity to edit

propertyTypeName - Fully qualified name of the property to delete

deleteProperty

default <T> Ack deleteProperty(ProjectEntity entity,
                               java.lang.Class<? extends PropertyType<T>> propertyType)

Deletes the value of a property.

Parameters:

entity - Type of the entity to edit

propertyType - Class of the property to delete

searchWithPropertyValue

<T> java.util.Collection<ProjectEntity> searchWithPropertyValue(java.lang.Class<? extends PropertyType<T>> propertyTypeClass,
                                                                java.util.function.BiFunction<ProjectEntityType,ID,ProjectEntity> entityLoader,
                                                                java.util.function.Predicate<T> predicate)

Searches for all entities with the corresponding property value.

findBuildByBranchAndSearchkey

@Nullable
<T> ID findBuildByBranchAndSearchkey(ID branchId,
                                               java.lang.Class<? extends PropertyType<T>> propertyType,
                                               java.lang.String searchKey)

Finds an item using its search key.

hasProperty

default <T> boolean hasProperty(ProjectEntity entity,
                                java.lang.Class<? extends PropertyType<T>> propertyTypeClass)

Tests if a property is defined.

copyProperty

<T> void copyProperty(ProjectEntity sourceEntity,
                      Property<T> property,
                      ProjectEntity targetEntity,
                      java.util.function.Function<java.lang.String,java.lang.String> replacementFn)

Copy/clones the property into the targetEntity after applying the replacement function.

Type Parameters:

T - Type of the property

Parameters:

sourceEntity - Owner of the property to copy

property - Property to copy

targetEntity - Entity to associate the new property with

replacementFn - Replacement function for textual values