C D E G I M O Q S T U V

C

currentValue - Variable in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

The actual value provided by the module.

D

DbIntegrityValidator - Interface in org.craftercms.commons.entitlements.validator

Defines the operations to validate a database.

DefaultDbIntegrityValidatorImpl - Class in org.craftercms.commons.entitlements.validator.impl

Default Implementation of DbIntegrityValidator.

DefaultDbIntegrityValidatorImpl() - Constructor for class org.craftercms.commons.entitlements.validator.impl.DefaultDbIntegrityValidatorImpl

DefaultEntitlementValidatorImpl - Class in org.craftercms.commons.entitlements.validator.impl

Default Implementation of EntitlementValidator.

DefaultEntitlementValidatorImpl() - Constructor for class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

E

Entitlement - Class in org.craftercms.commons.entitlements.model

Holds the value for a given entitlement type.

Entitlement() - Constructor for class org.craftercms.commons.entitlements.model.Entitlement

EntitlementExceededException - Exception in org.craftercms.commons.entitlements.exception

Exception thrown when the validation of an entitlement fails.

EntitlementExceededException(Module, EntitlementType, Number, Number) - Constructor for exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

EntitlementException - Exception in org.craftercms.commons.entitlements.exception

Base class for all entitlement related errors.

EntitlementException() - Constructor for exception org.craftercms.commons.entitlements.exception.EntitlementException

EntitlementException(String) - Constructor for exception org.craftercms.commons.entitlements.exception.EntitlementException

EntitlementException(String, Throwable) - Constructor for exception org.craftercms.commons.entitlements.exception.EntitlementException

EntitlementException(Throwable) - Constructor for exception org.craftercms.commons.entitlements.exception.EntitlementException

entitlementType - Variable in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

The entitlement that was being validated.

entitlementType - Variable in exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

The requested entitlement.

EntitlementType - Enum in org.craftercms.commons.entitlements.model

Holds the available entitlements when requesting an entitlement validation.

EntitlementUsageProvider - Interface in org.craftercms.commons.entitlements.usage

Defines the operations to support entitlement usage data in a module.

EntitlementValidator - Interface in org.craftercms.commons.entitlements.validator

Defines the operations to perform entitlement validations.

entitlementValue - Variable in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

The entitlement value found in the license file.

G

getClientId() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

Provides the client id of the current validator.

getCurrentUsage() - Method in interface org.craftercms.commons.entitlements.usage.EntitlementUsageProvider

Provides an list holding the current values for all entitlements supported by the current module.

getCurrentValue() - Method in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

getDescription() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

Provides a general description of the current validator.

getDescription() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

getEntitlementType() - Method in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

getEntitlementType() - Method in exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

getEntitlementValue() - Method in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

getId() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

Provides the id of the current validator.

getModule() - Method in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

getModule() - Method in exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

getModule() - Method in interface org.craftercms.commons.entitlements.usage.EntitlementUsageProvider

Identifies the current module running.

getPackageBuild() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

Provides the build of the containing JAR file.

getPackageVersion() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

Provides the version of the containing JAR file.

getType() - Method in class org.craftercms.commons.entitlements.model.Entitlement

getValue() - Method in class org.craftercms.commons.entitlements.model.Entitlement

getVersion() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

Provides the version of the current validator.

I

init() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

M

module - Variable in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

The module that requested the validation.

module - Variable in exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

The requested module.

Module - Enum in org.craftercms.commons.entitlements.model

Holds the available modules when requesting an entitlement validation.

O

org.craftercms.commons.entitlements.exception - package org.craftercms.commons.entitlements.exception

org.craftercms.commons.entitlements.model - package org.craftercms.commons.entitlements.model

org.craftercms.commons.entitlements.usage - package org.craftercms.commons.entitlements.usage

org.craftercms.commons.entitlements.validator - package org.craftercms.commons.entitlements.validator

org.craftercms.commons.entitlements.validator.impl - package org.craftercms.commons.entitlements.validator.impl

Q

query - Variable in class org.craftercms.commons.entitlements.validator.impl.DefaultDbIntegrityValidatorImpl

SQL statement to generate the validation value.

S

setEntitlementType(EntitlementType) - Method in exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

setModule(Module) - Method in exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

setType(EntitlementType) - Method in class org.craftercms.commons.entitlements.model.Entitlement

setValue(int) - Method in class org.craftercms.commons.entitlements.model.Entitlement

store(Connection) - Method in interface org.craftercms.commons.entitlements.validator.DbIntegrityValidator

Generates the validator value for a new database.

store(Connection) - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultDbIntegrityValidatorImpl

Generates the validator value for a new database.

T

toString() - Method in class org.craftercms.commons.entitlements.model.Entitlement

type - Variable in class org.craftercms.commons.entitlements.model.Entitlement

U

UnsupportedEntitlementException - Exception in org.craftercms.commons.entitlements.exception

Exception thrown when an invalid module or entitlement is requested during a validation.

UnsupportedEntitlementException(Module, EntitlementType) - Constructor for exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

V

validate(Connection) - Method in interface org.craftercms.commons.entitlements.validator.DbIntegrityValidator

Checks the validation value for an existing database.

validate(Connection) - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultDbIntegrityValidatorImpl

Checks the validation value for an existing database.

validateEntitlement(Module, EntitlementType, int, int) - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

Checks that an entitlement is below the value indicated in the configuration file.

value - Variable in class org.craftercms.commons.entitlements.model.Entitlement

valueOf(String) - Static method in enum org.craftercms.commons.entitlements.model.EntitlementType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.craftercms.commons.entitlements.model.Module

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.craftercms.commons.entitlements.model.EntitlementType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.craftercms.commons.entitlements.model.Module

Returns an array containing the constants of this enum type, in the order they are declared.

C D E G I M O Q S T U V