public interface

ProductLicenseInfo

com.microstrategy.utils.licensing.ProductLicenseInfo

Class Overview

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 getProductLicenseInfo(int) or getProductLicenseInfo(int, boolean).

Summary

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

Public Methods

public abstract 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.

public abstract 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.

public abstract int getProduct ()

Returns the product.

Returns

public abstract int getStatus ()

Returns the license status, from EnumProductLicenseStatuses.

Returns
  • int The license status.

public abstract 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.