de.hybris.platform.mcc.services

Interface LinkEntryService

All Known Implementing Classes:

DefaultLinkEntryService

public interface LinkEntryService

The Interface LinkEntryService provides methods related with AbstractLinkEntry items.

Spring Bean ID:

linkEntryService

Method Summary

Modifier and Type	Method and Description
java.util.List<AbstractLinkEntryModel>	getActiveLinkEntries(java.lang.String areaCode, boolean rootOnly) Returns sorted list of links (static, dynamic, dividers) for given area and current session user.
java.util.Map<java.lang.String,java.lang.String>	getDynamicLinks(java.lang.String script) Returns title->URL map created with given beanshell script.
java.lang.String	getLinkUrl(StaticLinkModel linkModel, HttpServletResponse servletResponse) Return link for given link model instance.
java.util.List<StaticLinkModel>	getVisibleSublinks(StaticLinkModel staticLink) Returns all sublinks of a static link that are visible for the current user
boolean	isVisible(AbstractLinkEntryModel linkModel) Returns whether a link is visible or not for the current user

Method Detail

getActiveLinkEntries

java.util.List<AbstractLinkEntryModel> getActiveLinkEntries(java.lang.String areaCode,
                                                            boolean rootOnly)

Returns sorted list of links (static, dynamic, dividers) for given area and current session user.

Parameters:

areaCode - - only links for given area code are returned

rootOnly - - if set to true no sublinks will be returned

Returns:

links collection for given area code and visible for current session user

getDynamicLinks

java.util.Map<java.lang.String,java.lang.String> getDynamicLinks(java.lang.String script)

Returns title->URL map created with given beanshell script. Beanshell script needs to return java.util.Map instance with string to string pairs.

Parameters:

script - - beanshell script

Returns:

title->URL links map

isVisible

boolean isVisible(AbstractLinkEntryModel linkModel)

Returns whether a link is visible or not for the current user

Parameters:

linkModel - the link model to check

Returns:

true, if the link is visible

getVisibleSublinks

java.util.List<StaticLinkModel> getVisibleSublinks(StaticLinkModel staticLink)

Returns all sublinks of a static link that are visible for the current user

Parameters:

staticLink - the parent link

Returns:

the list of visible sublinks

getLinkUrl

java.lang.String getLinkUrl(StaticLinkModel linkModel,
                            HttpServletResponse servletResponse)

Return link for given link model instance. Parses link attribute in the model and replaces {extname} and {property:...} expressions with the ones taken from the system.

Parameters:

linkModel - - model

servletResponse - - http servlet response to build up complete url

Returns:

- url as a string