org.dd4t.providers

Interface LinkProvider

public interface LinkProvider

Link provider.

Method Summary

Methods

Modifier and Type	Method and Description
String	resolveComponent(String targetComponentUri) Retrieves a link URL to a Component.
String	resolveComponent(String targetComponentUri, String excludeComponentTemplateUri) Retrieves a link URL to a Component with the option to exclude links to the specified component template.
String	resolveComponentFromPage(String targetComponentUri, String sourcePageUri) Retrieves a link URL to a Component from a Page.

Method Detail

resolveComponent

String resolveComponent(String targetComponentUri)
                        throws ItemNotFoundException,
                               SerializationException

Retrieves a link URL to a Component.

Parameters:

targetComponentUri - String representing the TcmUri of the Component to resolve a link to

Returns:

String representing the URL of the link; or null, if the Component is not resolved.

Throws:

ItemNotFoundException

SerializationException

resolveComponentFromPage

String resolveComponentFromPage(String targetComponentUri,
                              String sourcePageUri)
                                throws ItemNotFoundException,
                                       SerializationException

Retrieves a link URL to a Component from a Page.

Parameters:

targetComponentUri - String representing the TcmUri of the Component to resolve a link to

Returns:

String representing the URL of the link; or null, if the Component is not resolved

Throws:

ItemNotFoundException

SerializationException

resolveComponent

String resolveComponent(String targetComponentUri,
                      String excludeComponentTemplateUri)
                        throws ItemNotFoundException,
                               SerializationException

Retrieves a link URL to a Component with the option to exclude links to the specified component template.

Parameters:

targetComponentUri - String representing the TcmUri of the Component to resolve a link to

excludeComponentTemplateUri - The Component Presentation to exclude

Returns:

String representing the URL of the link; or null, if the Component is not resolved.

Throws:

ItemNotFoundException

SerializationException