com.sdl.web.api.linking

Interface Link

All Superinterfaces:

Serializable

public interface Link
extends Serializable

The future Link object is a bean that holds information about a link to a tridion resource. Other functional objects, like PageLink, ComponentLink and BinaryLink use this object.

All link properties can be modified after creation, allowing Template Designers to influence the Link object after creation.

Method Summary

Modifier and Type	Method and Description
String	getAnchor() Returns the anchor for this link.
String	getAttributes() Returns the attributes for this link.
String	getParameters() Returns the QueryString for this link.
String	getTargetURI() Returns the tcm:uri if the Item targeted by this link.
String	getText() Returns the link text for this link.
boolean	getTextOnFail() Returns the textOnFail value, which indicates if the link will return text if the targeted URI cannot be resolved or validated.
String	getURL() Returns the URL of the resolved item.
boolean	isResolved() Indicates if this link has been resolved and is targeting a valid URL.
void	setAnchor(String anchor) Sets the anchor of this Link instance.
void	setAttributes(String attributes) Sets the attributes for this Link instance.
void	setParameters(String parameters) Sets the QueryString of this Link instance.
void	setText(String text) Sets the link text for this Link instance.
void	setTextOnFail(boolean textOnFail) Sets the textOnFail property for this Link instance.
void	setURL(String url) Sets the URL of this Link instance.

Method Detail

getURL

String getURL()

Returns the URL of the resolved item. The URL uses linking configuration information.

Returns:

The URL to which this link object is pointing, or null if it could not be resolved.

setURL

void setURL(String url)

Sets the URL of this Link instance.

Parameters:

url - The new URL to which this link object should point.

getAnchor

String getAnchor()

Returns the anchor for this link.

Returns:

The anchor for this link.

setAnchor

void setAnchor(String anchor)

Sets the anchor of this Link instance.

Parameters:

anchor - The new anchor for this link.

getParameters

String getParameters()

Returns the QueryString for this link.

Returns:

The QueryString for this link.

setParameters

void setParameters(String parameters)

Sets the QueryString of this Link instance.

Parameters:

parameters - The new QueryString for this link instance.

getAttributes

String getAttributes()

Returns the attributes for this link.

Returns:

The attributes for this link.

setAttributes

void setAttributes(String attributes)

Sets the attributes for this Link instance.

Parameters:

attributes - The new attributes for this link instance.

getText

String getText()

Returns the link text for this link.

Returns:

The link text for this link.

setText

void setText(String text)

Sets the link text for this Link instance.

Parameters:

text - The new link text that should appear inside the link.

getTextOnFail

boolean getTextOnFail()

Returns the textOnFail value, which indicates if the link will return text if the targeted URI cannot be resolved or validated.

Returns:

The textOnFail property for this link.

setTextOnFail

void setTextOnFail(boolean textOnFail)

Sets the textOnFail property for this Link instance.

Parameters:

textOnFail - The new textOnFail value.

getTargetURI

String getTargetURI()

Returns the tcm:uri if the Item targeted by this link.

Returns:

The tcm:uri of this link's target.

isResolved

boolean isResolved()

Indicates if this link has been resolved and is targeting a valid URL.

Returns:

A boolean indicating if this link has resolved.