Interface PresentationVariantPropertyDefinition

  • All Superinterfaces:
    Wrapper

    public interface PresentationVariantPropertyDefinition
    extends Wrapper
    This class represents a property definition which is defined in the XML descriptor of a presentation. It defines the name, type and default value of a property.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getDataType()
      Returns the data type of this property definition, expressed as a String.
      String getDefaultValue()
      Returns the default value of this property definition.
      String getDisplayName()
      Returns the display name of the property definition, which is used to present this property in the edit UI where it is simply called "Name".
      String getName()
      Returns the name of the persisted JCR/Siteworks object associated with this property definition.
      String getPropertyName()
      Returns the name of the property definition to identify this definition.
      boolean isActive()
      Indicates of the presentation property is active or not.
      void setActive​(boolean active)
      Sets if the presentation property is active or not.
      void setDataType​(String dataType)
      Sets the data type of this property definition, expressed as a String.
      void setDefaultValue​(String defaultValue)
      Sets the default value of this property definition.
      void setDisplayName​(String displayName)
      Sets the display name of the property value, which is used to present this property in the edit UI where it is simply called "Name".
      void setName​(String definitionName)
      Sets the name of the persisted JCR/Siteworks object associated with this property definition.
      void setPropertyName​(String propertyName)
      Sets the name of the property definition to identify this definition.
    • Method Detail

      • getName

        String getName()
        Returns the name of the persisted JCR/Siteworks object associated with this property definition. This is a technical name usually generated from other properties when persisted. It is used only for Developer tools like the Edit Object light browser.
        Returns:
        technical name of the property definition
      • setName

        void setName​(String definitionName)
        Sets the name of the persisted JCR/Siteworks object associated with this property definition. This is a technical name usually generated from other properties when persisted. It is used only for Developer tools like the Edit Object light browser.
        Parameters:
        definitionName - the technical name of the property definition to set
      • isActive

        boolean isActive()
        Indicates of the presentation property is active or not. It may become inactive when the definition has been removed from the descriptor but is still in use by presentation properties in a presentation variant.
        Returns:
        Indicates of the presentation property is active or not
      • setActive

        void setActive​(boolean active)
        Sets if the presentation property is active or not. It may become inactive when the definition has been removed from the descriptor but is still in use by presentation properties in a presentation variant.
        Parameters:
        active - Indicates of the presentation property is active or not
      • getDisplayName

        String getDisplayName()
        Returns the display name of the property definition, which is used to present this property in the edit UI where it is simply called "Name".
        Returns:
        the display name of the property value
      • setDisplayName

        void setDisplayName​(String displayName)
        Sets the display name of the property value, which is used to present this property in the edit UI where it is simply called "Name".
        Parameters:
        displayName - the display name of the property value to set
      • getPropertyName

        String getPropertyName()
        Returns the name of the property definition to identify this definition. This is the "propertyname" as specified in the XML descriptor of the JSP. This name acts as an identifier, for presenting the definition in the UI of XC the displayname is used.
        Returns:
        name of the property definition associated with this value
      • setPropertyName

        void setPropertyName​(String propertyName)
        Sets the name of the property definition to identify this definition. This is the "propertyname" as specified in the XML descriptor of the JSP. This name acts as an identifier, for presenting the definition in the UI of XC the displayname is used.
        Parameters:
        propertyName - name of the property definition associated with this value
      • getDefaultValue

        String getDefaultValue()
        Returns the default value of this property definition.
        Returns:
        the default value of this property definition
      • setDefaultValue

        void setDefaultValue​(String defaultValue)
        Sets the default value of this property definition.
        Parameters:
        defaultValue - the default value of this property definition
      • getDataType

        String getDataType()
        Returns the data type of this property definition, expressed as a String.
        Returns:
        the data type of this property definition
      • setDataType

        void setDataType​(String dataType)
        Sets the data type of this property definition, expressed as a String.
        Parameters:
        dataType - the data type of this property definition to set