de.aristaflow.adept2.model.common

Interface LicenceInformation

public interface LicenceInformation

Licence information.

Author:

Kevin Goeser

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LicenceInformation.Activation The enumeration for different activation options.

Method Summary

Modifier and Type	Method and Description
LicenceInformation.Activation	getActivation() Returns whether an activation option.
java.util.Map<java.lang.String,java.lang.String>	getAdditions() Returns additional licence attributes.
java.lang.String	getCustomerID() Returns the customer ID.
java.lang.String	getDistributorID() Returns the ID of the distributor, or null if not applicable.
int	getIPAddressLimit() Returns the IP address limit as integer or 0 if there is no limit
byte	getIPAddressMask() Returns the mask value, or 0 if there is no mask or no limit.
int	getKnownUserLimit() Returns the overall number of users which are allowed to be known by the product or 0 if there is no user limit.
int	getLicenceID() Returns the ID of the licence.
java.lang.String	getLicenceType() Returns the licence type.
java.lang.String	getLicensee() Returns the name of the person or organisation to whom the licence has been issued, as it is displayed e.g. in the user interface.
java.util.List<java.lang.String>	getMailAddresses() Gets the mail addresses of the licensee.
java.lang.String[]	getProcessFlexibiltyEnabledTemplates() Returns the names of the process types the process flexibility is enabled for (cf.
java.lang.String[]	getProcessTypeLimit() Returns the names of the process types which are allowed for execution or null if unlimited.
java.util.Map<java.lang.String,java.lang.Boolean>	getProducts() Returns the names of the products (key) and if the usage is included in the licence (value).
java.lang.String[]	getRuntimeFlexibiltyEnabledTemplates() Returns the names of the process types the runtime flexibility is enabled for (cf.
java.util.Date	getTimeLimitEnd() Returns the date until which the licence is valid, or null if the usage time is not limited.
java.util.Date	getTimeLimitStart() Returns the start date from which the licence is valid, or null if the usage time is not limited.
int	getTransactionLimit() Returns the transactions which are allowed per day, or 0 if the daily transactions are not limited.
int	getUsingUserLimit() Returns the number of users which are allowed to be logged on concurrently or 0 if there is no user limit.
java.lang.String	getVersion() Returns the product version for which this licence has been issued.
boolean	isEscalationEnabled() Returns true, if the licence includes escalation.
boolean	isProcessFlexibilityEnabled() Returns true, if the process flexibility option is licensed.
boolean	isRuntimeFlexibilityEnabled() Returns true, if the runtime flexibility option is licensed.
boolean	isWebClientEnabled() Returns true, if the licence includes usage of the web client (server).

Method Detail

getLicenceID

int getLicenceID()

Returns the ID of the licence.

Returns:

The licence ID.

getCustomerID

java.lang.String getCustomerID()

Returns the customer ID.

Returns:

The ID of the customer.

getDistributorID

java.lang.String getDistributorID()

Returns the ID of the distributor, or null if not applicable.

Returns:

The ID of the distributor, or null if not applicable.

getLicenceType

java.lang.String getLicenceType()

Returns the licence type.

Returns:

The licence type.

getLicensee

java.lang.String getLicensee()

Returns the name of the person or organisation to whom the licence has been issued, as it is displayed e.g. in the user interface.

Returns:

The licensee.

getMailAddresses

java.util.List<java.lang.String> getMailAddresses()

Gets the mail addresses of the licensee. This addresses will be notified in case of severe licence violations.
For very old licences this can be an empty collection.

Returns:

The mail addresses of the licensee which to notify in case of severe licence violations.

getVersion

java.lang.String getVersion()

Returns the product version for which this licence has been issued.

Returns:

The product version for which this licence has been issued.

getActivation

LicenceInformation.Activation getActivation()

Returns whether an activation option.

Returns:

The activation option.

getTimeLimitStart

java.util.Date getTimeLimitStart()

Returns the start date from which the licence is valid, or null if the usage time is not limited.

Returns:

The start date when the licence is valid, or null if the usage time is not limited.

getTimeLimitEnd

java.util.Date getTimeLimitEnd()

Returns the date until which the licence is valid, or null if the usage time is not limited.

Returns:

The end date until when the licence is valid, or null if the usage time is not limited.

getTransactionLimit

int getTransactionLimit()

Returns the transactions which are allowed per day, or 0 if the daily transactions are not limited.

Returns:

The transactions which are allowed per day, or 0 if unlimited.

getKnownUserLimit

int getKnownUserLimit()

Returns the overall number of users which are allowed to be known by the product or 0 if there is no user limit.

Returns:

The overall number of users which are allowed to use the product or 0 if there is no user limit.

getUsingUserLimit

int getUsingUserLimit()

Returns the number of users which are allowed to be logged on concurrently or 0 if there is no user limit.

Returns:

The overall number of users which are allowed to be logged on concurrently or 0 if there is no user limit.

getIPAddressLimit

int getIPAddressLimit()

Returns the IP address limit as integer or 0 if there is no limit

Returns:

The IP address limit as integer or 0 if there is no limit.

getIPAddressMask

byte getIPAddressMask()

Returns the mask value, or 0 if there is no mask or no limit.

Returns:

The mask value, or 0 if there is no mask or no limit.

getProcessTypeLimit

java.lang.String[] getProcessTypeLimit()

Returns the names of the process types which are allowed for execution or null if unlimited.

Returns:

The names of the process types which are allowed for execution or null if unlimited.

isWebClientEnabled

boolean isWebClientEnabled()

Returns true, if the licence includes usage of the web client (server).

Returns:

True, if the licence includes usage of the web client (server).

isEscalationEnabled

boolean isEscalationEnabled()

Returns true, if the licence includes escalation.

Returns:

True, if the licence includes escalation.

getProducts

java.util.Map<java.lang.String,java.lang.Boolean> getProducts()

Returns the names of the products (key) and if the usage is included in the licence (value).

Returns:

The products and if their usage is included in the licence.

isProcessFlexibilityEnabled

boolean isProcessFlexibilityEnabled()

Returns true, if the process flexibility option is licensed.

Returns:

True, if the process flexibility option is licensed.

getProcessFlexibiltyEnabledTemplates

java.lang.String[] getProcessFlexibiltyEnabledTemplates()

Returns the names of the process types the process flexibility is enabled for (cf. isProcessFlexibilityEnabled()), or null the option is not limited. The return value has no meaning if the option is disabled.

Returns:

The names of the process types the process flexibility is enabled for, or null the option is not limited.

isRuntimeFlexibilityEnabled

boolean isRuntimeFlexibilityEnabled()

Returns true, if the runtime flexibility option is licensed.

Returns:

True, if the runtime flexibility option is licensed.

getRuntimeFlexibiltyEnabledTemplates

java.lang.String[] getRuntimeFlexibiltyEnabledTemplates()

Returns the names of the process types the runtime flexibility is enabled for (cf. isRuntimeFlexibilityEnabled()), or null the option is not limited. The return value has no meaning if the option is disabled.

Returns:

The names of the process types the runtime flexibility is enabled for, or null the option is not limited.

getAdditions

java.util.Map<java.lang.String,java.lang.String> getAdditions()

Returns additional licence attributes.

Returns:

Additional licence attributes.