Interface ComponentData

All Known Subinterfaces:
ContainerData, ContentFragmentData, EmbeddableData, ImageData, PageData

@ConsumerType public interface ComponentData
A base interface to be extended by components that need to enable data layer integration.
Since:
com.adobe.cq.wcm.core.components.models.datalayer 1.0.0
  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    Returns the component's description used in the data layer
    default String
    Returns the component's ID
    default @Nullable String
    Returns the JSON string of the component's properties used in the data layer
    default Date
    Returns the component's last modified date using ISO 8601 standard
    default String
    Returns the component's link URL used in the data layer
    default String
    Returns the component's parent ID
    default String
    Returns the component's text used in the data layer
    default String
    Returns the component's title used in the data layer
    default String
    Returns the component's type used in the data layer
  • Method Details

    • getId

      default String getId()
      Returns the component's ID
      Returns:
      string ID
      Since:
      com.adobe.cq.wcm.core.components.models.datalayer 1.0.0
    • getType

      default String getType()
      Returns the component's type used in the data layer
      Returns:
      type
      Since:
      com.adobe.cq.wcm.core.components.models.datalayer 1.0.0
    • getLastModifiedDate

      default Date getLastModifiedDate()
      Returns the component's last modified date using ISO 8601 standard
      Returns:
      lastModifiedDate
      Since:
      com.adobe.cq.wcm.core.components.models.datalayer 1.0.0
    • getParentId

      default String getParentId()
      Returns the component's parent ID
      Returns:
      The component's parent ID
      Since:
      com.adobe.cq.wcm.core.components.models.datalayer 1.0.0
    • getTitle

      default String getTitle()
      Returns the component's title used in the data layer
      Returns:
      src
      Since:
      com.adobe.cq.wcm.core.components.models.datalayer 1.0.0
    • getDescription

      default String getDescription()
      Returns the component's description used in the data layer
      Returns:
      description
      Since:
      com.adobe.cq.wcm.core.components.models.datalayer 1.0.0
    • getText

      default String getText()
      Returns the component's text used in the data layer
      Returns:
      text
      Since:
      com.adobe.cq.wcm.core.components.models.datalayer 1.0.0
    • getLinkUrl

      default String getLinkUrl()
      Returns the component's link URL used in the data layer
      Returns:
      link URL
      Since:
      com.adobe.cq.wcm.core.components.models.datalayer 1.0.0
    • getJson

      @Nullable default @Nullable String getJson()
      Returns the JSON string of the component's properties used in the data layer
      Returns:
      JSON string
      Since:
      com.adobe.cq.wcm.core.components.models.datalayer 1.0.0