senselogic.sitevision.api.link

Interface CustomLinkProcessor

All Superinterfaces:

Filter<String>

public interface CustomLinkProcessor
extends Filter<String>

Custom link processor interface that enables custom validation and data attributes rendering for specific link URLs.

Since:

Sitevision 4.0.4

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
CustomLinkRenderData	getRenderData(String aLinkURL) Gets custom render data for a link URL accepted by this link processor.
String	validate(String aLinkURL, Locale aLocale) Validates a link URL accepted by this link processor.

Methods inherited from interface senselogic.sitevision.api.base.Filter

accept

Method Detail

validate

String validate(String aLinkURL,
                Locale aLocale)

Validates a link URL accepted by this link processor.

Note! This method will only be called if Filter.accept(Object) returns true for aLinkURL.

Parameters:

aLinkURL - the link URL to validate

aLocale - the Locale to use for potential validation error message

Returns:

a localized validation error message, or null if validation passes

getRenderData

CustomLinkRenderData getRenderData(String aLinkURL)

Gets custom render data for a link URL accepted by this link processor.

Note! This method will only be called if Filter.accept(Object) returns true for aLinkURL.

Parameters:

aLinkURL - the link URL that should be rendered

Returns:

custom render data, or null if no custom render data is to be used