Package com.znize.platform.model.system

Interface Subscription

All Superinterfaces:

java.lang.Cloneable, CreatedDateAware, PersistenceEntity

public interface Subscription
extends PersistenceEntity, CreatedDateAware

Service subscription for a Tenant (DataAccessUnit), which has a reference to a service plan with a number of features. Feature names are either system-defined or application-defined. A subscription with optional free trial is automatically created when a tenant is created.

Since:

6.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Subscription.Status	Subscription status.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROPERTY_STATUS	Property name: status.
static java.lang.String	PROPERTY_TRIAL_END_DATE	Property name: trialEndDate.

Fields inherited from interface com.znize.platform.entity.CreatedDateAware

PROPERTY_CREATED_DATE

Fields inherited from interface com.znize.platform.entity.PersistenceEntity

ID_SEPARATOR, PROPERTY_ID, PROPERTY_INSTANCE, PROPERTY_SELECTED, PROPERTY_SEQUENCE_NO, PROPERTY_VERSION

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	getFeatureLevel(java.lang.String featureName)	Get feature level.
java.lang.Integer	getFeatureLimit(java.lang.String featureName)	Get feature limit.
java.util.Date	getRenewalDate()	Get renewal date.
java.util.Date	getStartDate()	Get start date.
Subscription.Status	getStatus()	Get status.
java.util.Date	getTrialEndDate()	Get the end date for free trial.
boolean	isFeatureEnabled(java.lang.String featureName)	Is the feature enabled? e.g., white-label branding.

Methods inherited from interface com.znize.platform.entity.CreatedDateAware

getCreatedDate, setCreatedDate

Methods inherited from interface com.znize.platform.entity.PersistenceEntity

clone, getId, getInstance, getSequenceNo, getVersion, isChanged, isPartiallyInitialized, isPersisted, isSelected, isStatistics, setChanged, setId, setInstance, setPartiallyInitialized, setPersisted, setSelected, setSequenceNo, setStatistics, setVersion

Field Detail

PROPERTY_STATUS

static final java.lang.String PROPERTY_STATUS

Property name: status.

See Also:

Constant Field Values

PROPERTY_TRIAL_END_DATE

static final java.lang.String PROPERTY_TRIAL_END_DATE

Property name: trialEndDate.

See Also:

Constant Field Values

Method Detail

getStartDate

java.util.Date getStartDate()

Get start date.

Returns:

start date

getTrialEndDate

java.util.Date getTrialEndDate()

Get the end date for free trial.

Returns:

trial end date

getRenewalDate

java.util.Date getRenewalDate()

Get renewal date. The initial renewal date is the start date plus free trial days.

Returns:

renewal date

getStatus

Subscription.Status getStatus()

Get status.

Returns:

status enum

getFeatureLimit

java.lang.Integer getFeatureLimit(java.lang.String featureName)

Get feature limit. e.g., user count limit, file storage limit in GB.

Parameters:

featureName - feature name

Returns:

maximum value as limit. return null if unlimited

isFeatureEnabled

boolean isFeatureEnabled(java.lang.String featureName)

Is the feature enabled? e.g., white-label branding.

Parameters:

featureName - feature name

Returns:

true if enabled, false otherwise

getFeatureLevel

java.lang.Integer getFeatureLevel(java.lang.String featureName)

Get feature level. e.g., support service level, capability level.

Parameters:

featureName - feature name

Returns:

level such as 1,2,3