Interface I_CmsDetailPageHandler

    • Method Detail

      • isValidDetailPage

        boolean isValidDetailPage​(CmsObject cms,
                                  CmsResource page,
                                  CmsResource detailRes)
        Checks whether the given detail page is valid for the given resource.

        cms - the CMS context
        page - the detail page
        detailRes - the detail resource
        true if the given detail page is valid
      • getAllDetailPages

        java.util.Collection<java.lang.String> getAllDetailPages​(CmsObject cms,
                                                                 int restype)
                                                          throws CmsException
        Finds all detail pages for a given resource.

        cms - the current CMS context
        restype - the resource type for which the detail pages should be found
        the list of detail page
        CmsException - in case reading the resource type fails
      • getDetailPage

        java.lang.String getDetailPage​(CmsObject cms,
                                       java.lang.String rootPath,
                                       java.lang.String linkSource,
                                       java.lang.String targetDetailPage)
        Returns the detail page link for the given resource, or null if there is no detail page for the resource.

        cms - the CMS context
        rootPath - the root path of the resource for which the detail page should be looked up
        linkSource - the uri in the context of which the detail page link is being generated (relative to the site)
        targetDetailPage - the target detail page to use
        the detail page link, or null
      • initialize

        void initialize​(CmsObject offlineCms,
                        CmsObject onlineCms)
        Initializes the detail page handler.
        offlineCms - offline CMS context
        onlineCms - online CMS context