Package org.broadleafcommerce.cms.structure.domain

Interface StructuredContentField

All Superinterfaces:
Cloneable, org.broadleafcommerce.common.copy.MultiTenantCloneable<StructuredContentField>, Serializable
All Known Implementing Classes:
StructuredContentFieldImpl
public interface StructuredContentField extends Serializable, Cloneable, org.broadleafcommerce.common.copy.MultiTenantCloneable<StructuredContentField>
Holds the values for custom fields that are part of a StructuredContent item.
Each item maintains a list of its custom fields. The fields associated with an item are determined by the FieldDefinitions associated with the StructuredContentType.
Author:
bpolster
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    StructuredContentField
    clone()
     
    String
    getFieldKey()
    Returns the fieldKey associated with this field.
    Long
    getId()
    Gets the primary key.
    String
    getValue()
    Sets the value of this custom field.
    void
    setFieldKey(String fieldKey)
    Sets the fieldKey.
    void
    setId(Long id)
    Sets the primary key.
    void
    setValue(String value)
    Returns the value for this custom field.

    Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

    createOrRetrieveCopyInstance

  • Method Details

    • getId

      @Nullable Long getId()
      Gets the primary key.
      Returns:
      the primary key

    • setId

      void setId(@Nullable Long id)
      Sets the primary key.
      Parameters:
      id - the new primary key

    • getFieldKey

      @Nonnull String getFieldKey()
      Returns the fieldKey associated with this field. The key used for a StructuredContentField is determined by the associated FieldDefinition that was used by the Content Management System to create this instance.

      As an example, a StructuredContentType might be configured to contain a field definition with a key of "targetUrl".

      Returns:
      the key associated with this item
      See Also:

    • setFieldKey

      void setFieldKey(@Nonnull String fieldKey)
      Sets the fieldKey.
      Parameters:
      fieldKey -
      See Also:

    • getValue

      @Nonnull String getValue()
      Sets the value of this custom field.
      Returns:

    • setValue

      void setValue(@Nonnull String value)
      Returns the value for this custom field.
      Parameters:
      value -

    • clone

      StructuredContentField clone()
      Returns:
      a deep copy of this object. By default, clones the fieldKey and value fields and ignores the auditable and id fields.