Package org.opencms.ade.detailpage

Interface I_CmsDetailPageHandler

All Superinterfaces:

I_CmsConfigurationParameterHandler

All Known Implementing Classes:

CmsDefaultDetailPageHandler, CmsPermissiveDetailPageHandler

public interface I_CmsDetailPageHandler
extends I_CmsConfigurationParameterHandler

Interface for classes which can find the detail page for a given resource, and determine whether a given detail page / detail content combination is valid.

Since:

8.0.0

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Method Summary

Modifier and Type	Method	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.
void	initialize(CmsObject offlineCms, CmsObject onlineCms)	Initializes the detail page handler.
boolean	isValidDetailPage(CmsObject cms, CmsResource page, CmsResource detailRes)	Checks whether the given detail page is valid for the given resource.

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

Method Detail

isValidDetailPage

boolean isValidDetailPage(CmsObject cms,
                          CmsResource page,
                          CmsResource detailRes)

Checks whether the given detail page is valid for the given resource.

Parameters:

cms - the CMS context

page - the detail page

detailRes - the detail resource

Returns:

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.

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)

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

initialize

void initialize(CmsObject offlineCms,
                CmsObject onlineCms)

Initializes the detail page handler.

Parameters:

offlineCms - offline CMS context

onlineCms - online CMS context