com.sdl.web.api.linking

Interface DynamicComponentLink

public interface DynamicComponentLink

The DynamicComponentLink validates links to Dynamic Component Presentations on Pages. This can be useful when it is known that a certain page can assemble Component Presentations but it is not known if both the page and the Component Presentation are available on the Delivery Server. The receiving page should implement the retrieval of HTTP-GET-parameters and use them to assemble the ComponentPresentation on the page. For this the ComponentPresentationAssembler can be used.

Method Summary

Modifier and Type	Method and Description
Link	getLink(int targetPageId, int targetComponentId, int targetTemplateId, String linkTagAttributes, String linkText, boolean showTextOnFail) This method tries to validate a link to a Dynamic Component Presentation on a Page.
Link	getLink(String targetPageURI, String targetComponentURI, String targetTemplateURI, String linkTagAttributes, String linkText, boolean showTextOnFail) This method tries to validate a link to a Dynamic Component Presentation on a Page.
String	getLinkAsString(int targetPageId, int targetComponentId, int targetTemplateId, String linkTagAttributes, String linkText, boolean showTextOnFail) This method tries to validate a link to a Dynamic Component Presentation on a Page.
String	getLinkAsString(String targetPageURI, String targetComponentURI, String targetTemplateURI, String linkTagAttributes, String linkText, boolean showTextOnFail) This method tries to validate a link to a Dynamic Component Presentation on a Page.

Method Detail

getLink

Link getLink(int targetPageId,
             int targetComponentId,
             int targetTemplateId,
             String linkTagAttributes,
             String linkText,
             boolean showTextOnFail)

This method tries to validate a link to a Dynamic Component Presentation on a Page. The result is returned as a Link object.

Parameters:

targetPageId - The id of the Page that is able to assemble Dynamic Component Presentations.

targetComponentId - The id of the Component of the targetted Dynamic Component Presentation.

targetTemplateId - The id of the Component Template of the targetted Dynamic Component Presentation.

linkTagAttributes - Any linkTagAttributes that should be added to the link, for instance an onMouseOver or style attribute.

linkText - The that should be placed inside the anchor tags.

showTextOnFail - This parameter indicates if a linkText should be returned if the link cannot be resolved

Returns:

The Link object, or null if there was an error.

See Also:

Link

getLink

Link getLink(String targetPageURI,
             String targetComponentURI,
             String targetTemplateURI,
             String linkTagAttributes,
             String linkText,
             boolean showTextOnFail)

This method tries to validate a link to a Dynamic Component Presentation on a Page. The result is returned as a Link object.

Parameters:

targetPageURI - The tcm:uri of the Page that is able to assemble Dynamic Component Presentations.

targetComponentURI - The tcm:uri of the Component of the targetted Dynamic Component Presentation.

targetTemplateURI - The tcm:uri of the Component Template of the targetted Dynamic Component Presentation.

linkTagAttributes - Any linkTagAttributes that should be added to the link, for instance an onMouseOver or style attribute.

linkText - The text that should be placed inside the anchor tags.

showTextOnFail - This parameter indicates if a text should be returned if the link cannot be resolved.

Returns:

The Link object, or NULL if there was an error.

See Also:

Link

getLinkAsString

String getLinkAsString(String targetPageURI,
                       String targetComponentURI,
                       String targetTemplateURI,
                       String linkTagAttributes,
                       String linkText,
                       boolean showTextOnFail)

This method tries to validate a link to a Dynamic Component Presentation on a Page. The result is returned as a java.lang.String object.

Parameters:

targetPageURI - The tcm:uri of the Page that is able to assemble Dynamic Component Presentations.

targetComponentURI - The tcm:uri of the Component of the targetted Dynamic Component Presentation.

targetTemplateURI - The tcm:uri of the Component Template of the targetted Dynamic Component Presentation.

linkTagAttributes - Any linkTagAttributes that should be added to the link, for instance an onMouseOver or style attribute.

linkText - The text that should be placed inside the anchor tags.

showTextOnFail - This parameter indicates if a text should be returned if the link cannot be resolved.

Returns:

A String representing the link.

getLinkAsString

String getLinkAsString(int targetPageId,
                       int targetComponentId,
                       int targetTemplateId,
                       String linkTagAttributes,
                       String linkText,
                       boolean showTextOnFail)

This method tries to validate a link to a Dynamic Component Presentation on a Page. The result is returned as a java.lang.String object.

Parameters:

targetPageId - The id of the Page that is able to assemble Dynamic Component Presentations.

targetComponentId - The id of the Component of the targetted Dynamic Component Presentation.

targetTemplateId - The id of the Component Template of the targetted Dynamic Component Presentation.

linkTagAttributes - Any linkTagAttributes that should be added to the link, for instance an onMouseOver or style attribute.

linkText - The that should be placed inside the anchor tags.

showTextOnFail - This parameter indicates if a text should be returned if the link cannot be resolved.

Returns:

A String representing the link.