Package com.microstrategy.utils.licensing

Interface ProductLicenseInfo

public interface ProductLicenseInfo

This interface provides information about a product license. Examples of products are "Web Reporter", "Web Analyst" and "Mobile". Instances of this interface can be obtained by calling LicensingSupport.getProductLicenseInfo(int) or LicensingSupport.getProductLicenseInfo(int, boolean).

Since:

MicroStrategy Web 8.1.1

Method Summary

Modifier and Type	Method	Description
int	getDaysLeft()	Returns the number of days before the license expires, if applicable.
int	getGracePeriodDays()	Returns the number of days in the grace period implied by the status (as returned by getStatus()), if applicable.
int	getProduct()	Returns the product.
int	getStatus()	Returns the license status, from EnumProductLicenseStatuses.
boolean	showWarningToAdminOnly()	In cases where an expiration warning needs to be shown (i.e.

Method Detail

getProduct

int getProduct()

Returns the product.

Returns:

int The product, from EnumProducts.

getStatus

int getStatus()

Returns the license status, from EnumProductLicenseStatuses.

Returns:

int The license status.

getDaysLeft

int getDaysLeft()

Returns the number of days before the license expires, if applicable.

Returns:

int If the status (as returned by getStatus()) is one of the NotExpired statuses, this method returns the number of days until the license expires. If the status is one of the Expired statuses, this method returns 0. Otherwise, this method returns -1.

getGracePeriodDays

int getGracePeriodDays()

Returns the number of days in the grace period implied by the status (as returned by getStatus()), if applicable.

Returns:

int For the Activation statuses, this method returns the number of days in the activation grace period. For the Evaluation statuses, this method returns the time-bound license period. Otherwise, this method returns -1.

showWarningToAdminOnly

boolean showWarningToAdminOnly()

In cases where an expiration warning needs to be shown (i.e. getStatus() returns one of the NotExpired statuses), this method returns whether the warning should be shown only to the administrator.

Returns:

boolean True if an expiration-related warning should be shown only to the administrator; false if the warning should be shown to all users.