com.crystaldecisions.sdk.plugin.desktop.licensekey
Interface ILicenseKeyBase

All Known Subinterfaces:

ILicenseKey

public interface ILicenseKeyBase

The ILicenseKey interface provides metrics on the license keys you have purchased with the product and allows you to add new license keys.

Field Summary

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

Method Summary

java.util.Date	getExpiryDate() Returns the expiry date of the license key, or null if there is no expiry date for this keycode.
java.util.Locale	getLanguage() Returns the license key's valid language.
int	getLicenseCount() Returns the number of licenses provided by the license key.
java.lang.String	getLicenseKey() Returns a current license key value.
java.lang.String	getMultilingualProductName(java.util.Locale locale) Returns the product name in the specified locale.
int	getNumBIAnalysts() Returns number of BI Analyst user license restrictions provided by this license key.
int	getNumBIViewers() Returns number of BI Viewer user license restrictions provided by this license key.
int	getProductLevel() Returns the product level.
int	getProductName() Returns the product enum.
int	getProductVersion() Returns the product version.
int	getPublicationRecipientLimit() Returns the publication recipient limit, or Integer.MAX_VALUE to represent unlimited recipients.
int	getUserLicenseType() Returns the type of license key.
boolean	isPublishingEnabled() Returns whether or not the key enables publishing.
boolean	isRoleBased() Returns whether or not the license key is used with the role-based licensing model.
void	setLicenseKey(java.lang.String newLicenseKey) Sets the license key value.

Field Detail

KIND

static final java.lang.String KIND

The Kind used to query for LicenseKey objects.

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID for the LicenseKey Class.

ProgID	CrystalEnterprise.LicenseKey
Query Category	CI_SYSTEMOBJECTS
Associated Interface	com.crystaldecisions.sdk.plugin.desktop.licensekey.ILicenseKey

Query syntax:

SELECT
	SI_EXPIRY_DATE, SI_LANGUAGE, SI_LICENSE_COUNT, SI_LICENSE_KEY, SI_LICENSE_TYPE, SI_PRODUCT_LEVEL, SI_PRODUCT_NAME, SI_PRODUCT_VERSION
FROM
	CI_SYSTEMOBJECTS
WHERE
	SI_PROGID='CrystalEnterprise.LicenseKey'

The CePropertyIDs named in the SELECT statement are those that are required to access data through the ILicenseKey interface. For more information on their associations with the interface's methods, see ILicenseKey

See Also:

Constant Field Values

Method Detail

getLicenseKey

java.lang.String getLicenseKey()

Returns a current license key value.

Returns:

A String containing a current license key value.

See Also:

ILicenseKeyBase.setLicenseKey(java.lang.String)

InfoObject properties to query for:

SI_LICENSE_KEY

setLicenseKey

void setLicenseKey(java.lang.String newLicenseKey)

Sets the license key value.

Parameters:

newLicenseKey - A String containing a new license key value.

See Also:

ILicenseKeyBase.getLicenseKey()

getProductName

int getProductName()

Returns the product enum.

Returns:

An int specifying the product name.

See Also:

CeProductName

InfoObject properties to query for:

SI_PRODUCT_NAME

getMultilingualProductName

java.lang.String getMultilingualProductName(java.util.Locale locale)

Returns the product name in the specified locale.

Returns:

An String specifying the product name.

InfoObject properties to query for:

SI_PRODUCT_ML_NAME

getProductLevel

int getProductLevel()

Returns the product level.

Returns:

An int specifying the product level.

See Also:

CeProductLevel

InfoObject properties to query for:

SI_PRODUCT_LEVEL

getProductVersion

int getProductVersion()

Returns the product version.

Returns:

An int specifying the product version.

InfoObject properties to query for:

SI_PRODUCT_VERSION

getUserLicenseType

int getUserLicenseType()

Returns the type of license key. For example, possible types are Concurrent and Named.

Returns:

An int specifying the type of license key. 0 specifies that the license type is concurrent, while 1 specifies that it is named.

InfoObject properties to query for:

SI_LICENSE_TYPE

getLicenseCount

int getLicenseCount()

Returns the number of licenses provided by the license key.

Returns:

An int specifying the number of licenses provided by the license key.

InfoObject properties to query for:

SI_LICENSE_COUNT

getExpiryDate

java.util.Date getExpiryDate()

Returns the expiry date of the license key, or null if there is no expiry date for this keycode.

Returns:

A Date object containing the expiry date of the license key, or null if this key doesn't expire.

InfoObject properties to query for:

SI_EXPIRY_DATE

getLanguage

java.util.Locale getLanguage()

Returns the license key's valid language.

Returns:

A Locale object specifying the license key's valid language.

InfoObject properties to query for:

SI_LANGUAGE

isRoleBased

boolean isRoleBased()

Returns whether or not the license key is used with the role-based licensing model. For example, BI Analyst and BI Viewer users are part of the role-based licensing model.

Returns:

true if the license key is defined for the role-based licensing model, false otherwise.

Since:

4.0

InfoObject properties to query for:

SI_ROLE_BASED

isPublishingEnabled

boolean isPublishingEnabled()

Returns whether or not the key enables publishing.

Returns:

true if publishing is enabled, false otherwise.

getPublicationRecipientLimit

int getPublicationRecipientLimit()

Returns the publication recipient limit, or Integer.MAX_VALUE to represent unlimited recipients. If publishing is not enabled, the return value is 0.

Returns:

The publication recipient limit, or 0 if publishing is not enabled.

getNumBIViewers

int getNumBIViewers()

Returns number of BI Viewer user license restrictions provided by this license key.

Returns:

The number of BI Viewer user license restrictions.

getNumBIAnalysts

int getNumBIAnalysts()

Returns number of BI Analyst user license restrictions provided by this license key.

Returns:

The number of BI Analyst user license restrictions.