public interface

RWHyperlink

com.microstrategy.web.objects.rw.RWHyperlink

Summary

Constants
int LINK_TYPE_EXECUTE
int LINK_TYPE_URL
int PROMPT_ANSWER_TYPE_MSGID
int PROMPT_ANSWER_TYPE_NO_ANSWER
int PROMPT_ANSWER_TYPE_XML
Public Methods
abstract void addAttribute(String attrID)
Adds a new attribute to the attributes collection
abstract void clearAttributes()
abstract WebAttribute[] getAttributes()
Returns a modifiable list of attributes
abstract String getDisplayText()
abstract String getHyperlink()
Returns the url (@see #getURL()) if the hyperlink is of type LINK_TYPE_URL If the hyperlink is of type LINK_TYPE_EXECUTE, then a hyperlink representation based on the current parameters is returned
abstract int getLinkType()
Returns the type of link
abstract int getPromptAnswersType()
abstract WebObjectInfo getTargetObject()
abstract String getURL()
Returns the url (if any) associated with the hyperlink
abstract boolean isDefault()
Indicates whether this is the default url
abstract boolean openInNewWindow()
abstract void setDefault(boolean def)
Set the current hyperlink as the default
abstract void setDisplayText(String text)
abstract void setLinkType(int type)
abstract void setOpenInNewWindow(boolean open)
abstract void setPromptsAnswersType(int type)
abstract void setTargetObject(WebObjectInfo obj)
abstract void setURL(String url)

Constants

public static final int LINK_TYPE_EXECUTE

Constant Value: 1 (0x00000001)

public static final int LINK_TYPE_URL

Constant Value: 0 (0x00000000)

public static final int PROMPT_ANSWER_TYPE_MSGID

Constant Value: 1 (0x00000001)

public static final int PROMPT_ANSWER_TYPE_NO_ANSWER

Constant Value: 0 (0x00000000)

public static final int PROMPT_ANSWER_TYPE_XML

Constant Value: 2 (0x00000002)

Public Methods

public abstract void addAttribute (String attrID)

Adds a new attribute to the attributes collection

Throws
IllegalArgumentException if the attribute ID that is passed in does not correspond to a valid attribute in one of the datasets

public abstract void clearAttributes ()

public abstract WebAttribute[] getAttributes ()

Returns a modifiable list of attributes

public abstract String getDisplayText ()

public abstract String getHyperlink ()

Returns the url (@see #getURL()) if the hyperlink is of type LINK_TYPE_URL If the hyperlink is of type LINK_TYPE_EXECUTE, then a hyperlink representation based on the current parameters is returned

public abstract int getLinkType ()

Returns the type of link

public abstract int getPromptAnswersType ()

public abstract WebObjectInfo getTargetObject ()

public abstract String getURL ()

Returns the url (if any) associated with the hyperlink

public abstract boolean isDefault ()

Indicates whether this is the default url

public abstract boolean openInNewWindow ()

public abstract void setDefault (boolean def)

Set the current hyperlink as the default

public abstract void setDisplayText (String text)

public abstract void setLinkType (int type)

public abstract void setOpenInNewWindow (boolean open)

public abstract void setPromptsAnswersType (int type)

public abstract void setTargetObject (WebObjectInfo obj)

public abstract void setURL (String url)