public interface

WebHyperLink

com.microstrategy.web.objects.WebHyperLink

Class Overview

The WebHyperLink interface represents the Hyperlink associated with grid report cell or RWD text field.

Summary

Constants
int LINK_TYPE_EXECUTE This value represents an executable report/RWD link.
int LINK_TYPE_MOBILE_URL This value represents an mobile action link.
int LINK_TYPE_URL This value represents a URL link.
Public Methods
abstract String getAnswerXML()
Return a string that shall be used for answering the target report's or docuemt's prompts.
abstract WebHyperLinkAnswers getAnswers()
Returns WebHyperLinkAnswers the answers for prompts in the target report or document.
abstract int getDefaultAnswerMode()
Returns a default answer mode that shall be used for target report's or document's prompts.
abstract String getDisplayText()
Returns link's display text.
abstract int getLinkType()
Returns the type of link, the return value comes from LINK_TYPE_URL and LINK_TYPE_EXECUTE
abstract String getSelectorOptions()
Indicates whether to copy the selector's selections when link drilling from one document to another.
abstract WebObjectInfo getTargetObject()
Returns link's target - a report or a document, this method is only applicable for LINK_TYPE_EXECUTE.
abstract String getURL()
Returns the target URL link If the link type is LINK_TYPE_URL or LINK_TYPE_MOBILE_URL this method returns this Hyperlink's URL, otherwise it returns null.
abstract boolean isDefault()
Indicates whether this is the default Hyperlink
abstract void setDefault(boolean def)
Sets/Unsets the Hyperlink as default If there are more than one Hyperlink associated with a report cell or RWD text field, only one Hyperlink can be set as default
abstract void setDefaultAnswerMode(int value)
Sets default answer mode for this Hyperlink This method is only applicable for LINK_TYPE_EXECUTE
abstract void setDisplayText(String text)
Sets link's display text.
abstract void setLinkType(int type)
Sets the type of Hyperlink
abstract void setSelectorOptions(String selectorOptions)
Indicates whether to copy the selector's selections when link drilling from one document to another.
abstract void setTargetObject(WebObjectInfo obj)
Sets link's target - a report or a document, this method is only applicable for LINK_TYPE_EXECUTE.
abstract void setURL(String url)
Sets Hyperlinks's URL if the link type is LINK_TYPE_URL, or LINK_TYPE_MOBILE_URL.

Constants

public static final int LINK_TYPE_EXECUTE

This value represents an executable report/RWD link.

Constant Value: 1 (0x00000001)

public static final int LINK_TYPE_MOBILE_URL

This value represents an mobile action link. Actually it works the same with url link.

Constant Value: 2 (0x00000002)

public static final int LINK_TYPE_URL

This value represents a URL link.

Constant Value: 0 (0x00000000)

Public Methods

public abstract String getAnswerXML ()

Return a string that shall be used for answering the target report's or docuemt's prompts. This method is only applicable for LINK_TYPE_EXECUTE

Returns
  • a string that shall be used for answering the target prompts.

public abstract WebHyperLinkAnswers getAnswers ()

Returns WebHyperLinkAnswers the answers for prompts in the target report or document. If the link type is LINK_TYPE_URL or LINK_TYPE_MOBILE_URL the method returns null.

Returns

public abstract int getDefaultAnswerMode ()

Returns a default answer mode that shall be used for target report's or document's prompts. This method is only applicable for LINK_TYPE_EXECUTE

Returns
  • A value from EnumLinkAnswerMode which will be used for target report's or document's prompts

public abstract String getDisplayText ()

Returns link's display text. The link's display text represents the link.

Returns
  • link's display text.

public abstract int getLinkType ()

Returns the type of link, the return value comes from LINK_TYPE_URL and LINK_TYPE_EXECUTE

Returns
  • a int representing the type of this link.

public abstract String getSelectorOptions ()

Indicates whether to copy the selector's selections when link drilling from one document to another.
The options are:
- 0 - Do not pass selector values
- 1 - Pass selector values - match selectors by ID
- 2 - Pass selector values - match selectors by name

public abstract WebObjectInfo getTargetObject ()

Returns link's target - a report or a document, this method is only applicable for LINK_TYPE_EXECUTE.

Returns
  • A WebObjectInfo object corresponding to the target report or document

public abstract String getURL ()

Returns the target URL link If the link type is LINK_TYPE_URL or LINK_TYPE_MOBILE_URL this method returns this Hyperlink's URL, otherwise it returns null.

Returns
  • a string representing link's URL

public abstract boolean isDefault ()

Indicates whether this is the default Hyperlink

Returns
  • true is the Hyperlink is the default link of the report cell or RWD text field.

public abstract void setDefault (boolean def)

Sets/Unsets the Hyperlink as default If there are more than one Hyperlink associated with a report cell or RWD text field, only one Hyperlink can be set as default

Parameters
def If this is true, then Hyperlink will be set as default link of the report cell or RWD text field.

public abstract void setDefaultAnswerMode (int value)

Sets default answer mode for this Hyperlink This method is only applicable for LINK_TYPE_EXECUTE

Parameters
value the value for different answer modes, which refers to EnumLinkAnswerMode

public abstract void setDisplayText (String text)

Sets link's display text. The link's display text represents the link.

Parameters
text the link's display text

public abstract void setLinkType (int type)

Sets the type of Hyperlink

Parameters
type the type of Hyperlink. This value comes from LINK_TYPE_URL, LINK_TYPE_EXECUTE and LINK_TYPE_MOBILE_URL

public abstract void setSelectorOptions (String selectorOptions)

Indicates whether to copy the selector's selections when link drilling from one document to another.
The options are:
- 0 - Do not pass selector values
- 1 - Pass selector values - match selectors by ID
- 2 - Pass selector values - match selectors by name

public abstract void setTargetObject (WebObjectInfo obj)

Sets link's target - a report or a document, this method is only applicable for LINK_TYPE_EXECUTE.

Parameters
obj WebObjectInfo report or document which will be set as this Hyperlink's target.

public abstract void setURL (String url)

Sets Hyperlinks's URL if the link type is LINK_TYPE_URL, or LINK_TYPE_MOBILE_URL. This method is applicable for LINK_TYPE_URL and LINK_TYPE_MOBILE_URL.

Parameters
url the URL string