Package oracle.communication.brm.charging.extensions.client

Interface RatingExtension

All Superinterfaces:
oracle.communication.brm.charging.extensions.framework.ExtensionCallback<RatingExtensionContext>
All Known Implementing Classes:
SampleRatingExtension
public interface RatingExtension extends oracle.communication.brm.charging.extensions.framework.ExtensionCallback<RatingExtensionContext>
Rating extension API invoked as a part of OCS to execute customer behavior at key phases in the charging workflow. custom extension code.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    handlePostApplyAlteration(RatingExtensionContext extensionContext)
    This extension point is executed by the OCS immediately following the "alteration" calculation for a usage request.
    void
    handlePostApplyCharge(RatingExtensionContext extensionContext)
    This extension point is executed by the OCS immediately following the "charge" calculation for a usage request.
    void
    handlePostApplyDistribution(RatingExtensionContext extensionContext)
    This extension point is executed by the OCS immediately following the "distribution" calculation for a usage request.
    void
    handlePostApplyTaxation(RatingExtensionContext extensionContext)
    This extension point is executed by the OCS immediately following the "taxation" calculation for a usage request.
    void
    initialize(ExtensionContext extensionContext)
    method is invoked once at ECS Node startup time to allow integrators a spot to populate private data members that are required by the extension callback.
    void
    shutdown(ExtensionContext extensionContext)
    method is invoked once at ECS Node shutdown time to allow integrators a spot to release any resources that were acquired by the Extension.

  • Method Details

    • initialize

      void initialize(ExtensionContext extensionContext) throws ExtensionException
      Description copied from interface: oracle.communication.brm.charging.extensions.framework.ExtensionCallback
      method is invoked once at ECS Node startup time to allow integrators a spot to populate private data members that are required by the extension callback.
      Specified by:
      initialize in interface oracle.communication.brm.charging.extensions.framework.ExtensionCallback<RatingExtensionContext>
      Parameters:
      extensionContext - the context which exposes objects that are needed at initialization time.
      Throws:
      ExtensionException - if a non-recoverable error occurs during initialization.

    • handlePostApplyCharge

      void handlePostApplyCharge(RatingExtensionContext extensionContext) throws ExtensionException
      This extension point is executed by the OCS immediately following the "charge" calculation for a usage request. Operators can implement this method to effect the "charge" calculation.
      Parameters:
      extensionContext - the available context data that can be accessed during the post apply charge rating flow.
      Throws:
      ExtensionException - if a non-recoverable error occurs during extension execution.

    • handlePostApplyAlteration

      void handlePostApplyAlteration(RatingExtensionContext extensionContext) throws ExtensionException
      This extension point is executed by the OCS immediately following the "alteration" calculation for a usage request. Operators can implement this method to effect the "alteration" calculation.
      Parameters:
      extensionContext - the available context data that can be accessed during the post apply alteration rating flow.
      Throws:
      ExtensionException - if a non-recoverable error occurs during extension execution.

    • handlePostApplyDistribution

      void handlePostApplyDistribution(RatingExtensionContext extensionContext) throws ExtensionException
      This extension point is executed by the OCS immediately following the "distribution" calculation for a usage request. Operators can implement this method to effect the "distribution" calculation.
      Parameters:
      extensionContext - the available context data that can be accessed during the post apply distribution rating flow.
      Throws:
      ExtensionException - if a non-recoverable error occurs during extension execution.

    • handlePostApplyTaxation

      void handlePostApplyTaxation(RatingExtensionContext extensionContext) throws ExtensionException
      This extension point is executed by the OCS immediately following the "taxation" calculation for a usage request. Operators can implement this method to effect the "taxation" calculation.
      Parameters:
      extensionContext - the available context data that can be accessed during the post apply taxation rating flow.
      Throws:
      ExtensionException - if a non-recoverable error occurs during extension execution.

    • shutdown

      void shutdown(ExtensionContext extensionContext) throws ExtensionException
      Description copied from interface: oracle.communication.brm.charging.extensions.framework.ExtensionCallback
      method is invoked once at ECS Node shutdown time to allow integrators a spot to release any resources that were acquired by the Extension.
      Specified by:
      shutdown in interface oracle.communication.brm.charging.extensions.framework.ExtensionCallback<RatingExtensionContext>
      Parameters:
      extensionContext - the context which exposes objects that are needed at shutdown time.
      Throws:
      ExtensionException - if a non-recoverable error occurs during shutdown.