Package org.openbravo.erpCommon.obps

Interface ModuleLicenseRestrictions

public interface ModuleLicenseRestrictions

Modules can check for License restrictions. To do so this interface should be implemented. Note that classes implementing this interface should be annotated as @ApplicationScoped.

Author:

alostale

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ModuleLicenseRestrictions.ActivationMsg	holder for activation key messages
static class	ModuleLicenseRestrictions.AdditionalInfo	Holder for additional messages.
static class	ModuleLicenseRestrictions.MsgSeverity

Method Summary

Modifier and Type	Method	Description
ActivationKey.LicenseRestriction	checkRestrictions(ActivationKey activationKey, String currentSession)	Returns LicenseRestrictions applicable to this instance, or null or LicenseRestriction.NO_RESTRICTION in case of no restriction.
ModuleLicenseRestrictions.ActivationMsg	getActivationMessage(ActivationKey activationKey, String lang)	Returns a message related to activation key or null none required.
List<ModuleLicenseRestrictions.AdditionalInfo>	getAdditionalMessage()	Provides a mechanism to returns an extra message.
String	getInstanceActivationExtraActionsHtml(XmlEngine xmlEngine)	Provides the HTML to be injected in Instance Activation window to perform additional actions

Method Detail

checkRestrictions

ActivationKey.LicenseRestriction checkRestrictions(ActivationKey activationKey,
                                                   String currentSession)

Returns LicenseRestrictions applicable to this instance, or null or LicenseRestriction.NO_RESTRICTION in case of no restriction.

getActivationMessage

ModuleLicenseRestrictions.ActivationMsg getActivationMessage(ActivationKey activationKey,
                                                             String lang)

Returns a message related to activation key or null none required. It will be shown in:

• Login Page
• Instance Activation window

getInstanceActivationExtraActionsHtml

String getInstanceActivationExtraActionsHtml(XmlEngine xmlEngine)

Provides the HTML to be injected in Instance Activation window to perform additional actions

getAdditionalMessage

List<ModuleLicenseRestrictions.AdditionalInfo> getAdditionalMessage()

Provides a mechanism to returns an extra message. This information will be shown in Instance Activation window.