Package org.opencms.ade.configuration

Interface I_CmsSitemapExtraInfoProvider

public interface I_CmsSitemapExtraInfoProvider
Interface for plugin classes that provide extra information to be dynamically injected into the sitemap configuration.

  • Method Summary

    Modifier and Type
    Method
    Description
    I_CmsSitemapExtraInfo
    getExtraInfo(CmsObject cms)
    Gets the information to be injected into the sitemap configuration.
    int
    getOrder()
    Gets the order number.

  • Method Details

    • getExtraInfo

      I_CmsSitemapExtraInfo getExtraInfo(CmsObject cms)
      Gets the information to be injected into the sitemap configuration.
      Parameters:
      cms - an Admin CMS context (does not contain the current request context, but is in the Online/Offline project depending on whether the online/offline sitemap configuration is being evaluated)
      Returns:
      the extra information to be injected into the sitemap configuration

    • getOrder

      int getOrder()
      Gets the order number.

      Implementations of this interface are used in ascending order, so the ones with higher order can override information from ones with a lower order.

      Returns:
      the order number