com.sdl.web.api.linking

Interface BinaryLink

public interface BinaryLink

The BinaryLink interface provides functionality to link to a binary resource based on a tcm:uri. Besides validating that the Binary is available on the Delivery System, it also makes sure that the correct name and path are used to link to existing binaries.

Method Summary

Modifier and Type	Method and Description
Link	getLink(String binaryComponentURI, String anchor, String linkText, String linkTagAttributes, boolean showTextOnFail) The getLink method tries to find the location of the binary and wraps this location in a Link object.
Link	getLink(String binaryComponentURI, String variantId, String anchor, String linkText, String linkTagAttributes, boolean showTextOnFail) The getLink method tries to find the location of the binary and wraps this location in a Link object.
String	getLinkAsString(String binaryComponentURI, String anchor, String linkText, String linkTagAttributes, boolean showTextOnFail) The getLinkAsString method calls the getLink method to create a link object.
String	getLinkAsString(String binaryComponentURI, String variantId, String anchor, String linkText, String linkTagAttributes, boolean showTextOnFail) The getLinkAsString method calls the getLink method to create a link object.

Method Detail

getLink

Link getLink(String binaryComponentURI,
             String variantId,
             String anchor,
             String linkText,
             String linkTagAttributes,
             boolean showTextOnFail)

The getLink method tries to find the location of the binary and wraps this location in a Link object.

Parameters:

binaryComponentURI - The binaryComponentURI of the binary to be linked to.

variantId - The id of the variant of the binary to be linked to

anchor - The anchor on the page where the link has to be pointing to. Use an empty String or null for this in normal situations.

linkText - The linkText for the link

linkTagAttributes - Optional query that should be placed in the anchor.

showTextOnFail - Indicated if the linkText parameter should be used if the link does not validate.

Returns:

A link object with a filled in URL if the link was resolved, or with a null-URL if the binary could not be found.

getLink

Link getLink(String binaryComponentURI,
             String anchor,
             String linkText,
             String linkTagAttributes,
             boolean showTextOnFail)

The getLink method tries to find the location of the binary and wraps this location in a Link object.

Parameters:

binaryComponentURI - The binaryComponentURI of the binary to be linked to.

anchor - The anchor on the page where the link has to be pointing to. Use an empty String or null for this in normal situations.

linkText - The linkText for the link

linkTagAttributes - Optional query that should be placed in the anchor.

showTextOnFail - Indicated if the linkText parameter should be used if the link does not validate.

Returns:

A link object with a filled in URL if the link was resolved, or with a null-URL if the binary could not be found.

getLinkAsString

String getLinkAsString(String binaryComponentURI,
                       String variantId,
                       String anchor,
                       String linkText,
                       String linkTagAttributes,
                       boolean showTextOnFail)

The getLinkAsString method calls the getLink method to create a link object. After this, it calls toString() on this Link-object and returns this as a return value.

Parameters:

binaryComponentURI - The binaryComponentURI of the binary to be linked to.

variantId - The variant id of the binary to be linked to.

anchor - The anchor on the page where the link has to be pointing to. Use an empty String or null for this in normal situations.

linkText - The linkText for the link

linkTagAttributes - Optional query that should be placed in the anchor.

showTextOnFail - Indicated if the linkText parameter should be used if the link does not resolve or validate.

Returns:

A link in the form of an <a href="...">linkText</a> if the link resolves and validates or, if showTextOnFail is true the linkText if it doesn't and if showTextOnFail is false "".

getLinkAsString

String getLinkAsString(String binaryComponentURI,
                       String anchor,
                       String linkText,
                       String linkTagAttributes,
                       boolean showTextOnFail)

The getLinkAsString method calls the getLink method to create a link object. After this, it calls toString() on this Link-object and returns this as a return value.

Parameters:

binaryComponentURI - The binaryComponentURI of the binary to be linked to.

anchor - The anchor on the page where the link has to be pointing to. Use an empty String or null for this in normal situations.

linkText - The linkText for the link

linkTagAttributes - Optional query that should be placed in the anchor.

showTextOnFail - Indicated if the linkText parameter should be used if the link does not resolve or validate.

Returns:

A link in the form of an <a href="...">linkText</a> if the link resolves and validates or, if showTextOnFail is true the linkText if it doesn't and if showTextOnFail is false "".