net.brokenbuild.subcomponents.api

Class ComponentPropertyService

java.lang.Object

net.brokenbuild.subcomponents.api.ComponentPropertyService

public class ComponentPropertyService
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ComponentPropertyService(net.brokenbuild.subcomponents.service.customprops.propvalue.PropValueHelper propValueHelper)

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	getValue(long componentId, int propertyId) Retrieves the value of a specified property for a given component ID.
java.lang.String	setValue(long componentId, int propertyId, java.lang.String propValue) Sets the value of a specified property name for a given component ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentPropertyService

public ComponentPropertyService(net.brokenbuild.subcomponents.service.customprops.propvalue.PropValueHelper propValueHelper)

Method Detail

getValue

public java.util.Optional<java.lang.String> getValue(long componentId,
                                                     int propertyId)

Retrieves the value of a specified property for a given component ID.

This method fetches the value of a property associated with a specific component based on the given component ID and property name. If the user is unauthorized to access this data, a SubcomponentsAuthException is thrown. If any other error occurs during the process, a SubcomponentsApiException is thrown.

Parameters:

componentId - The ID of the component for which the property value needs to be fetched.

propertyId - The ID of the property whose value is to be retrieved.

Returns:

An Optional containing the property value if found, or an empty Optional if not found.

Throws:

SubcomponentsAuthException - if the user is unauthorized to access the property value.

SubcomponentsApiException - if any other error occurs while fetching the property value.

Since:

3.9.0

setValue

public java.lang.String setValue(long componentId,
                                 int propertyId,
                                 java.lang.String propValue)

Sets the value of a specified property name for a given component ID.

This method sets the value of a property associated with a specific component based on the given component ID, property id, and the new value to be set. If the updated value doesn't pass validation, a SubcomponentsValidationException is thrown. If the user is unauthorized to update this data, a SubcomponentsAuthException is thrown. For other unexpected errors, a SubcomponentsApiException is thrown.

Parameters:

componentId - The ID of the component for which the property value needs to be updated.

propertyId - The ID of the property whose value is to be updated.

propValue - The new value for the property.

Returns:

A String response holding the new value after the update operation.

Throws:

SubcomponentsValidationException - if the updated value fails validation checks.

SubcomponentsAuthException - if the user is unauthorized to update the property value.

SubcomponentsApiException - if any other error occurs while updating the property value.

Since:

3.9.0