com.tridion.linking.events

Interface ComponentLinkListener

All Superinterfaces:

LinkListener

All Known Implementing Classes:

Linking

public interface ComponentLinkListener
extends LinkListener

Implement this interface to enable link resolution tracking in external software.

Method Summary

Modifier and Type	Method and Description
void	componentLinkNotification(int publicationId, int sourcePageId, int targetComponentId, int excludeComponentTemplateId, String linkTagAttributes, String linkText, boolean showTextOnFail, boolean showAnchor, Link returnLink) Implement this method to process the parameters passed.
void	dynamicComponentLinkNotification(int publicationId, int sourcePageId, int targetComponentId, int excludeComponentTemplateId, String linkTagAttributes, String linkText, boolean showTextOnFail, String parameters, Link returnLink) Implement this method to process the parameters passed.

Methods inherited from interface com.tridion.linking.events.LinkListener

configure

Method Detail

componentLinkNotification

void componentLinkNotification(int publicationId,
                               int sourcePageId,
                               int targetComponentId,
                               int excludeComponentTemplateId,
                               String linkTagAttributes,
                               String linkText,
                               boolean showTextOnFail,
                               boolean showAnchor,
                               Link returnLink)

Implement this method to process the parameters passed. Then configure the ComponentLinkListener section in the Linking configuration file to enable the implemented class. The com.tridion.linking.Linking class will pass all ComponentLinks which the system tries to resolve to the configured class, which will then be processed in the configured class.

Parameters:

publicationId - The Id of the publication which the Component the link is trying to resolve to is in.

sourcePageId - The Id of the page that you are linking from.

targetComponentId - The Id of the Component you wish to try to resolve a link to.

excludeComponentTemplateId - The Id of the Component Template which will be excluded from link resolution, and which will be used to exclude other templates based on priority.

linkTagAttributes - Attributes to include in the link.

linkText - The text to be displayed for the link.

showTextOnFail - Indicates if the linkText needs to be returned if no link can be resolved.

showAnchor - The anchor on the page where the link has to be pointing to.

returnLink - The Link resolved by the ComponentLink class.

dynamicComponentLinkNotification

void dynamicComponentLinkNotification(int publicationId,
                                      int sourcePageId,
                                      int targetComponentId,
                                      int excludeComponentTemplateId,
                                      String linkTagAttributes,
                                      String linkText,
                                      boolean showTextOnFail,
                                      String parameters,
                                      Link returnLink)

Implement this method to process the parameters passed. Then configure the ComponentLinkListener section in the Linking configuration file to enable the implemented class. The com.tridion.linking.Linking class will pass all DynamicComponentLinks which the system tries to resolve to the configured class, which will then be processed in the configured class.

Parameters:

publicationId - The Id of the publication which the page the returnLink is trying to resolve to is in.

sourcePageId - The Id of the page the returnLink is trying to resolve to.

targetComponentId - The Id of the Component you wish to try to resolve a returnLink to.

excludeComponentTemplateId - The Id of the Component Template to be used for DCP assembly.

linkTagAttributes - Attributes to include in the returnLink.

linkText - The text to be displayed for the returnLink.

showTextOnFail - Indicates if the linkText needs to be returned if no returnLink can be resolved.

parameters - HTTP parameters to be appended to the URL.

returnLink - The Link resolved by the DynamicComponentLink class.