Package org.craftercms.commons.entitlements.usage

Interface EntitlementUsageProvider

public interface EntitlementUsageProvider
Defines the operations to support entitlement usage data in a module. Each module must provide an implementation of this interface.
Author:
joseross

  • Method Details

    • getModule

      Module getModule()
      Identifies the current module running.
      Returns:
      value from Module

    • getSupportedEntitlements

      List<EntitlementType> getSupportedEntitlements()

    • getEntitlementUsage

      default int getEntitlementUsage(EntitlementType type)
      Returns the current usage for a given entitlement type in the current module
      Parameters:
      type - the entitlement to check
      Returns:
      the current usage

    • doGetEntitlementUsage

      int doGetEntitlementUsage(EntitlementType type) throws Exception
      Performs the module specific operations to get the current value of the given entitlement
      Parameters:
      type - the entitlement to check
      Returns:
      the current usage
      Throws:
      Exception

    • getCurrentUsage

      default List<Entitlement> getCurrentUsage()
      Provides a list holding the current values for all entitlements supported by the current module.
      Returns:
      the entitlement list