Interface PresentationVariantPropertyValue

  • All Superinterfaces:
    Wrapper

    public interface PresentationVariantPropertyValue
    extends Wrapper
    This class represents a value of a presentation property. A presentation may define presentation properties in its XML descriptor, defining the name, type and default value of the property. We refer to this part as the property definition. When such a property definition is used in a presentation variant, an actual value is assigned. This is referred to as the property value. This class represents the actual value assigned to a property definition in a presentation variant and is returned by PresentationVariant.getPropertyValues. Access the definition from getPropertyDefinitionName. Note that the property definition is defined programmatically ( in the XML descriptor of the presentation JSP) while the value is defined at runtime by an editor, by creating a presentation variant.
    • Method Detail

      • getName

        String getName()
        Returns the name of the presentation property value object. This name is not visible in the UI, nor is it of any use in the API. Its sole purpose is to give the object a technical name, such that it can be identified in Developer tools.
        Returns:
        name of the presentation property value object
      • setName

        void setName​(String name)
        Sets the name of the presentation property value object. This name is not visible in the UI, nor is it of any use in the API. Its sole purpose is to give the object a technical name, such that it can be identified in Developer tools.
        Parameters:
        name - name of the presentation property value object
      • getPropertyDefinition

        PresentationVariantPropertyDefinition getPropertyDefinition()
        Returns the property definition associated with this value. This is the "property" as specified in the XML descriptor of the JSP.
        Returns:
        the property definition associated with this value
      • setPropertyDefinition

        void setPropertyDefinition​(PresentationVariantPropertyDefinition definitionName)
        Sets the the property definition associated with this value. This is the "property" as specified in the XML descriptor of the JSP.
        Parameters:
        definitionName - the property definition associated with this value
      • getValue

        String getValue()
        Returns the value of this property value. The value is always stored as a String.
        Returns:
        value of this property value
      • setValue

        void setValue​(String value)
        Sets the value of this property value. The value is always stored as a String.
        Parameters:
        value - value of this property value