Package org.craftercms.commons.entitlements.validator

Interface EntitlementValidator

All Known Implementing Classes:
DefaultEntitlementValidatorImpl
public interface EntitlementValidator
Defines the operations to perform entitlement validations.
Author:
joseross

  • Method Summary

    Modifier and Type
    Method
    Description
    default long
    getClientId()
    Provides the client id of the current validator.
    String
    getDescription()
    Provides a general description of the current validator.
    default long
    getId()
    Provides the id of the current validator.
    default String
    getPackageBuild()
    Provides the build of the containing JAR file.
    default String
    getPackageVersion()
    Provides the version of the containing JAR file.
    default String
    getVersion()
    Provides the version of the current validator.
    default void
    validateEntitlement(EntitlementType entitlementType, int newAmount)
    Checks that an entitlement is below the value indicated in the configuration file.

  • Method Details

    • validateEntitlement

      default void validateEntitlement(EntitlementType entitlementType, int newAmount) throws EntitlementException
      Checks that an entitlement is below the value indicated in the configuration file.
      Parameters:
      entitlementType - entitlement to be validated
      newAmount - amount of items to be created
      Throws:
      EntitlementException - if the validation fails

    • getId

      default long getId()
      Provides the id of the current validator.
      Returns:
      id of the validator

    • getClientId

      default long getClientId()
      Provides the client id of the current validator.
      Returns:
      if of the client

    • getVersion

      default String getVersion()
      Provides the version of the current validator.
      Returns:
      the version

    • getDescription

      String getDescription()
      Provides a general description of the current validator.
      Returns:
      validator description

    • getPackageVersion

      default String getPackageVersion()
      Provides the version of the containing JAR file.
      Returns:
      the version

    • getPackageBuild

      default String getPackageBuild()
      Provides the build of the containing JAR file.
      Returns:
      the build