Class RelevantCharacteristicProperty


  • public class RelevantCharacteristicProperty
    extends Object
    Keeps the information related to a relevant characteristic property.
    • Method Detail

      • getEntity

        public Entity getEntity()
        Returns:
        The entity that references the characteristic through the base path
      • getBasePath

        public String getBasePath()
        Returns:
        the base path the points to the relevant characteristic property, without including the relevant characteristic property name. It may be null, for example when the entity is the Product entity
      • getName

        public String getName()
        Returns:
        the name of the relevant characteristic property
      • getSearchKey

        public String getSearchKey()
        Returns:
        the search key of the referenced relevant characteristic
      • getFieldName

        public String getFieldName()
        Returns:
        the name to be used in the that points to this property. This is the name of the List for the relevant characteristic in the list reference of relevant characteristics.
      • getCharacteristicId

        public String getCharacteristicId()
        Returns:
        the id of the Characteristic linked to the relevant characteristic in the client of the current context
      • getCharacteristicValue

        public CharacteristicValue getCharacteristicValue​(BaseOBObject bob)
        Retrieves the value of the characteristic linked to the relevant characteristic for the given BaseOBObject
        Parameters:
        bob - A BaseOBObject
        Returns:
        the value of the characteristic linked to the relevant characteristic for the given BaseOBObject
      • from

        public static Optional<RelevantCharacteristicProperty> from​(Field field)
        Retrieves a new RelevantCharacteristicProperty instance for the relevant characteristic referenced by the given Field.
        Parameters:
        field - The AD field
        Returns:
        an Optional describing the RelevantCharacteristicProperty or an empty Optional in case the property cannot be resolved
      • from

        public static Optional<RelevantCharacteristicProperty> from​(Entity entity,
                                                                    String propertyPath)
        Retrieves a new RelevantCharacteristicProperty instance for the relevant characteristic pointed by the given Entity and property path.
        Parameters:
        entity - The Entity owner of the property path
        propertyPath - The path that references the relevant characteristic property
        Returns:
        an Optional describing the RelevantCharacteristicProperty or an empty Optional in case the property cannot be resolved
      • getRelevantCharateristicProperties

        public static Set<String> getRelevantCharateristicProperties()
        Returns:
        a set with the property name of the existing relevant characteristics