Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • getSurplus - returns amount of units that can be used by another other bundles,
  • updateSurplus - updates the surplus with a the given value, and returns the part that is above the maximum surplus value - (which is defined on VALUE_3),
  • save - saves the object.

A subscription_bundle that is used by rollover bundles, utilizes all four value parameters:

  • VALUE_1 - number of units inside bundle,
  • VALUE_2 - number of units used inside the bundle's own period,
  • VALUE_3 - maximum number of units, that can be rolled over
  • VALUE_4 - number of used rollover units (units used outside the bundle's own period).

Subscription Bundle Update Manager

...

In order to configure DataBundle, DurationBundle, EventBundle or ForwardBundle to use rollover functionality the following parameters must be set up in the bundle's parameters and meta data:

Name

Description

ROLLOVER.PERIOD.ORDER

Defines whether older or newer surplus should be used first. Two possible values are possible: NEWER_FIRST and OLDER_FIRST

ROLLOVER.USAGE.MODE

Indicates whether surplus should be used before or after the SubscriptionBundles. Again two values are possible: USE_ROLLOVER_BEFORE_BUNDLE, USE_ROLLOVER_AFTER_BUNDLE

ROLLOVER.PERIODS

Amount of previous SubscriptionBundles used in rollover. In other words, the number defines how many times surplus can be rolled over

UPDATE_MANAGER

DEFAULT for the standard functionality without rollover. This is the standard implementation used if this parameter is not set. 

ROLLOVER for enabling the rollover functionality enabled. Meta data properties are:
Rollover periods: The number of periods considered for rollover.
Rollover before or after: Indicates whether the surplus should be used before or after the actual subscription bundle.
Rollover order: Either NEWER_FIRST for using the newest free units, or OLDER_FIRST for using the oldest free units. 

UNLIMITED for a variation of the standard functionality, where zero fee units free units (VALUE_1=0) are considered unlimited number of free units.