com.crystaldecisions.sdk.plugin.desktop.hyperlink
Interface IHyperlinkBase

All Known Subinterfaces:

IHyperlink

public interface IHyperlinkBase

This interface allows you to retrieve and set the url for a hyperlink object. Therefore, you can set a link to a url and use SAP BusinessObjects Enterprise as a portal to navigate to this location.

Field Summary

static java.lang.String	KIND The Kind used to query for Hyperlink objects.
static java.lang.String	PROGID The ProgID for the Hyperlink Class.

Method Summary

java.lang.String	getHyperlink() Returns the url of a hyperlink object.
void	setHyperlink(java.lang.String url) Sets the url of a hyperlink object.

Field Detail

KIND

static final java.lang.String KIND

The Kind used to query for Hyperlink objects.

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID for the Hyperlink Class.

ProgID	CrystalEnterprise.Hyperlink
Query Category	CI_INFOOBJECTS
Associated Interface	com.crystaldecisions.sdk.plugin.desktop.hyperlink.IHyperlink

Query syntax:

SELECT
	SI_DESCRIPTION, SI_NAME, SI_ID
FROM
	CI_INFOOBJECTS
WHERE
	SI_PROGID='CrystalEnterprise.Hyperlink'

The IHyperlink interface does not contain any methods or properties that require specific CePropertyIDs to be referenced in the SELECT Statement. However, you can access general InfoObject properties, such as the SI_NAME, SI_DESCRIPTION, and SI_ID from the objects returned by the query. For more information, see hyperlink.

See Also:

Constant Field Values

Method Detail

getHyperlink

java.lang.String getHyperlink()
                              throws SDKException

Returns the url of a hyperlink object.

Returns:

A String that represents the url of a hyperlink object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_HYPERLINK_STRING

setHyperlink

void setHyperlink(java.lang.String url)

Sets the url of a hyperlink object.

Parameters:

url - A String that specifies the url of a hyperlink object.

Throws:

SDKRuntimeException - This is thrown if the string contains "javascript:" or "vbscript:"