org.opencms.ade.detailpage

Interface I_CmsDetailPageFinder

All Known Implementing Classes:

CmsSitemapDetailPageFinder

public interface I_CmsDetailPageFinder

Interface for classes which can find the detail page for a given resource.

Since:

8.0.0

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getAllDetailPages(CmsObject cms, int restype) Finds all detail pages for a given resource.
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.

Method Detail

getAllDetailPages

java.util.Collection<java.lang.String> getAllDetailPages(CmsObject cms,
                                                         int restype)
                                                  throws CmsException

Finds all detail pages for a given resource.

Parameters:

cms - the current CMS context

restype - the resource type for which the detail pages should be found

Returns:

the list of detail page

Throws:

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)
                        throws CmsException

Returns the detail page link for the given resource, or null if there is no detail page for the resource.

Parameters:

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

Returns:

the detail page link, or null

Throws:

CmsException - if something goes wrong