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 and Description
long	getClientId() Provides the client id of the current validator.
String	getDescription() Provides a general description of the current validator.
long	getId() Provides the id of the current validator.
String	getPackageBuild() Provides the build of the containing JAR file.
String	getPackageVersion() Provides the version of the containing JAR file.
String	getVersion() Provides the version of the current validator.
void	validateEntitlement(Module module, EntitlementType entitlementType, int currentValue, int newAmount) Checks that an entitlement is below the value indicated in the configuration file.

Method Detail

validateEntitlement

void validateEntitlement(Module module,
                         EntitlementType entitlementType,
                         int currentValue,
                         int newAmount)
                  throws EntitlementException

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

Parameters:

module - module requesting the validation

entitlementType - entitlement to be validated

currentValue - current value provided by the module

newAmount - amount of items to be created

Throws:

EntitlementException - if the validation fails

getId

long getId()

Provides the id of the current validator.

Returns:

id of the validator

getClientId

long getClientId()

Provides the client id of the current validator.

Returns:

if of the client

getVersion

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

String getPackageVersion()

Provides the version of the containing JAR file.

Returns:

the version

getPackageBuild

String getPackageBuild()

Provides the build of the containing JAR file.

Returns:

the build