UniversalChargeEventListener (SAP CC 5.0 Java APIs (Core Library))

java.lang.Object
- com.highdeal.cnd.message.UniversalChargeEventListener

All Implemented Interfaces:

AcquisitionListener, ActivateEventListener, BatchChargeEventListener, ChargeEventListener, ChargeExceptionListener, ChargingResultListener, CheckLimitEventListener, CleanupEventListener, ForbiddenChargeExceptionListener, IMonitorSpendingStatusResultListener, InvalidItemListener, ISessionResultListener, PrePostRateEventListener, SessionEventListener, TranslateEventListener
```
public class UniversalChargeEventListener
extends java.lang.Object
implements ChargeEventListener, ChargingResultListener, CleanupEventListener, CheckLimitEventListener, PrePostRateEventListener, ActivateEventListener, TranslateEventListener, SessionEventListener, BatchChargeEventListener, ISessionResultListener, AcquisitionListener, IMonitorSpendingStatusResultListener
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.highdeal.cnd.message.IMonitorSpendingStatusResultListener
  IMonitorSpendingStatusResultListener.ISpendingStatusMonitoringResult, IMonitorSpendingStatusResultListener.MonitoringAction

Constructor Summary

Constructors
Constructor and Description

UniversalChargeEventListener(int timeout)

Constructors
Constructor and Description
`UniversalChargeEventListener(int timeout)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<AcquisitionResult>`	`getAcquisitionResults()`
`PurchaseOrder`	`getActivateResult()`
`BatchChargeResult`	`getBatchChargeResult()`
`ChargingResult`	`getChargingResult()`
`CheckLimitResult`	`getCheckLimitResult()`
`CleanupResult`	`getCleanupResult()`
`StartSubscriptionReratingResult`	`getInformStartSubscriptionRerating()`
`boolean`	`getInformStopSubscriptionRerating()`
`PostRateResult`	`getPostRateResult()`
`PreRateResult`	`getPreRateResult()`
`PurchaseOrder`	`getPurchaseOrder()`
`ISessionOperationResult`	`getSessionResult()`
`IMonitorSpendingStatusResultListener.ISpendingStatusMonitoringResult`	`getSpendingStatusMonitoringResult()`
`StartRateResult`	`getStartRateResult()`
`StopRateResult`	`getStopRateResult()`
`java.lang.Object[]`	`getTranslateResult()`
`UpdateRateResult`	`getUpdateRateResult()`
`void`	`onException(ActivateException e)` Invoked when the activate operation fails because of an `ActivateException`.
`void`	`onException(BatchChargeException e)` Invoked when the cleanup operation fails because of a `batchChargeException`.
`void`	`onException(CannotInverseException e)` Invoked when the check limit operation fails because of a `CannotInverseException`.
`void`	`onException(CleanupException e)` Invoked when the cleanup operation fails because of a `CleanupException`.
`void`	`onException(CommunicationFailureException e)` Invoked when a network issue has been detected.
`void`	`onException(DoesNotExistException e)` Invoked when the translate operation fails because the translation table does not exist.
`void`	`onException(ForbiddenChargeException e)` Invoked when the rating is not allowed.
`void`	`onException(java.lang.IllegalArgumentException e)` Invoked when an argument of an operation request is invalid.
`void`	`onException(InvalidItemException e)` Invoked when a chargeable item was invalid and the `InvalidItemException` is thrown by the connected SAP CC system.
`void`	`onException(PostRateException e)` Invoked when the postrate operation fails because of a `PostRateException`.
`void`	`onException(PreRateException e)` Invoked when the prerate operation fails because of a `PreRateException`.
`void`	`onException(RerateSubscriptionException e)` Invoked when the rerating operation fails because of a `RerateSubscriptionException`.
`void`	`onException(ServerFailureException e)` Invoked when the rater instances in the connected SAP CC system can not handle the business operation request.
`void`	`onException(StartRateException e)` Invoked when rating session can not be created.
`void`	`onException(StopRateException e)` Invoked when usage transactions can not be cleared.
`void`	`onException(TransactionClearingException e)` Invoked if the Transaction Processor plugged on the PnR output, is not able to clear at least one of the generated transactions.
`void`	`onException(UpdateRateException e)` Invoked when rating session can not be updated.
`void`	`onResult(BatchChargeResult b)` Invoked when the cleanup operation is successful.
`void`	`onResult(boolean reratingResult, int fromSnapshotId, java.util.Date fromDate)`
`void`	`onResult(ChargingResult result)` Invoked when the charging operation is successful.
`void`	`onResult(CheckLimitResult result)` Invoked when the check limit operation is successful.
`void`	`onResult(CleanupResult result)` Invoked when the cleanup operation is successful.
`void`	`onResult(IMonitorSpendingStatusResultListener.ISpendingStatusMonitoringResult spendingStatusMonitoringResult)` Invoked each time a request of spending status monitoring has been processed successfully.
`void`	`onResult(java.util.List<AcquisitionResult> results)` Invoked by the `asynchronous batch service client` when the SAP CC system returns the result of the `AsyncBatchServiceClient.acquire(List, AcquisitionListener)` method.
`void`	`onResult(java.lang.Object[] translate)` Invoked when the translate operation is successful.
`void`	`onResult(PostRateResult result)` Invoked when the postrate operation is successful.
`void`	`onResult(PreRateResult result)` Invoked when the prerate operation is successful.
`void`	`onResult(PurchaseOrder order)` Invoked when the charging operation is successful.
`void`	`onSessionError(SessionOperationException error)` Invoked each time a session event has not been processed because session control raised an exception.
`void`	`onSessionResult(ISessionOperationResult result)` Invoked each time a session event has been processed, successfully or not.
`void`	`onStartRateResult(StartRateResult result)` Invoked when the start rate operation is successful.
`void`	`onStopRateResult(StopRateResult result)` Invoked when the stop rate operation is successful.
`void`	`onUpdateRateResult(UpdateRateResult result)` Invoked when the update rate operation is successful.
`boolean`	`pingReratingOperationResult()`
`void`	`waitForResponse()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UniversalChargeEventListener

public UniversalChargeEventListener(int timeout)

Method Detail

onResult
```
public void onResult(PurchaseOrder order)
```
Description copied from interface: ChargeEventListener

Invoked when the charging operation is successful.

Specified by:

onResult in interface ActivateEventListener

Specified by:

onResult in interface ChargeEventListener

Parameters:

order - The {PurchaseOrder result} of the charging operation

onResult
```
public void onResult(ChargingResult result)
```
Description copied from interface: ChargingResultListener

Invoked when the charging operation is successful.

Specified by:

onResult in interface ChargingResultListener

Parameters:

result - the result of the charging operation

onException
```
public void onException(TransactionClearingException e)
```
Description copied from interface: ChargeEventListener

Invoked if the Transaction Processor plugged on the PnR output, is not able to clear at least one of the generated transactions.

Specified by:

onException in interface ActivateEventListener

Specified by:

onException in interface BatchChargeEventListener

Specified by:

onException in interface ChargeEventListener

Specified by:

onException in interface ChargingResultListener

Specified by:

onException in interface CheckLimitEventListener

Specified by:

onException in interface CleanupEventListener

Specified by:

onException in interface PrePostRateEventListener

Specified by:

onException in interface SessionEventListener

Parameters:

e - The Transaction Clearing exception to be handled

onException
```
public void onException(java.lang.IllegalArgumentException e)
```
Description copied from interface: ChargeExceptionListener

Invoked when an argument of an operation request is invalid.

Specified by:

onException in interface ChargeExceptionListener

Parameters:

e - The exception to be handled

onException
```
public void onException(InvalidItemException e)
```
Description copied from interface: InvalidItemListener

Invoked when a chargeable item was invalid and the InvalidItemException is thrown by the connected SAP CC system.

Specified by:

onException in interface InvalidItemListener

Specified by:

onException in interface SessionEventListener

Parameters:

e - The exception to be handled in your client application

onException
```
public void onException(ForbiddenChargeException e)
```
Description copied from interface: ChargeEventListener

Invoked when the rating is not allowed.

Specified by:

onException in interface ActivateEventListener

Specified by:

onException in interface BatchChargeEventListener

Specified by:

onException in interface ChargeEventListener

Specified by:

onException in interface ChargingResultListener

Specified by:

onException in interface CheckLimitEventListener

Specified by:

onException in interface CleanupEventListener

Specified by:

onException in interface ForbiddenChargeExceptionListener

Specified by:

onException in interface IMonitorSpendingStatusResultListener

Specified by:

onException in interface PrePostRateEventListener

Specified by:

onException in interface SessionEventListener

Parameters:

e - The Forbidden Charge exception to be handled

onException
```
public void onException(ServerFailureException e)
```
Description copied from interface: ChargeExceptionListener

Invoked when the rater instances in the connected SAP CC system can not handle the business operation request.

Specified by:

onException in interface ChargeExceptionListener

Parameters:

e - The exception to be handled

onException
```
public void onException(CommunicationFailureException e)
```
Description copied from interface: ChargeExceptionListener

Invoked when a network issue has been detected.

Specified by:

onException in interface ChargeExceptionListener

Parameters:

e - The exception to be handled

onException
```
public void onException(CleanupException e)
```
Description copied from interface: CleanupEventListener

Invoked when the cleanup operation fails because of a CleanupException.

Specified by:

onException in interface CleanupEventListener

Parameters:

e - the exception to be handled.

onResult
```
public void onResult(CleanupResult result)
```
Description copied from interface: CleanupEventListener

Invoked when the cleanup operation is successful.

Specified by:

onResult in interface CleanupEventListener

Parameters:

result - the result of the cleanup operation.

onException
```
public void onException(CannotInverseException e)
```
Description copied from interface: CheckLimitEventListener

Invoked when the check limit operation fails because of a CannotInverseException.

Specified by:

onException in interface CheckLimitEventListener

Parameters:

e - the exception to be handled.

onResult
```
public void onResult(CheckLimitResult result)
```
Description copied from interface: CheckLimitEventListener

Invoked when the check limit operation is successful.

Specified by:

onResult in interface CheckLimitEventListener

Parameters:

result - the result of the charging operation.

onException
```
public void onException(PreRateException e)
```
Description copied from interface: PrePostRateEventListener

Invoked when the prerate operation fails because of a PreRateException.

Specified by:

onException in interface PrePostRateEventListener

Parameters:

e - the exception to be handled.

onException
```
public void onException(PostRateException e)
```
Description copied from interface: PrePostRateEventListener

Invoked when the postrate operation fails because of a PostRateException.

Specified by:

onException in interface PrePostRateEventListener

Parameters:

e - the exception to be handled.

onResult
```
public void onResult(PreRateResult result)
```
Description copied from interface: PrePostRateEventListener

Invoked when the prerate operation is successful.

Specified by:

onResult in interface PrePostRateEventListener

Parameters:

result - the result of the prerate operation.

onResult
```
public void onResult(PostRateResult result)
```
Description copied from interface: PrePostRateEventListener

Invoked when the postrate operation is successful.

Specified by:

onResult in interface PrePostRateEventListener

Parameters:

result - the result of the postrate operation.

onException
```
public void onException(ActivateException e)
```
Description copied from interface: ActivateEventListener

Invoked when the activate operation fails because of an ActivateException.

Specified by:

onException in interface ActivateEventListener

Parameters:

e - the exception to be handled.

onException
```
public void onException(DoesNotExistException e)
```
Description copied from interface: TranslateEventListener

Invoked when the translate operation fails because the translation table does not exist.

Specified by:

onException in interface TranslateEventListener

Parameters:

e - the exception to be handled.

onResult
```
public void onResult(java.lang.Object[] translate)
```
Description copied from interface: TranslateEventListener

Invoked when the translate operation is successful.

Specified by:

onResult in interface TranslateEventListener

Parameters:

translate - an array of the translated Object.

onException
```
public void onException(StartRateException e)
```
Description copied from interface: SessionEventListener

Invoked when rating session can not be created.

Specified by:

onException in interface SessionEventListener

Parameters:

e - the exception to be handled.

onException
```
public void onException(StopRateException e)
```
Description copied from interface: SessionEventListener

Invoked when usage transactions can not be cleared.

Specified by:

onException in interface SessionEventListener

Parameters:

e - the exception to be handled.

onException
```
public void onException(UpdateRateException e)
```
Description copied from interface: SessionEventListener

Invoked when rating session can not be updated.

Specified by:

onException in interface SessionEventListener

Parameters:

e - the exception to be handled.

onStartRateResult
```
public void onStartRateResult(StartRateResult result)
```
Description copied from interface: SessionEventListener

Invoked when the start rate operation is successful.

Specified by:

onStartRateResult in interface SessionEventListener

Parameters:

result - a rating result used to reserve the balance.

onStopRateResult
```
public void onStopRateResult(StopRateResult result)
```
Description copied from interface: SessionEventListener

Invoked when the stop rate operation is successful.

Specified by:

onStopRateResult in interface SessionEventListener

Parameters:

result - the result of the stop rate operation.

onUpdateRateResult
```
public void onUpdateRateResult(UpdateRateResult result)
```
Description copied from interface: SessionEventListener

Invoked when the update rate operation is successful.

Specified by:

onUpdateRateResult in interface SessionEventListener

Parameters:

result - the result of the cleanup operation.

onSessionResult
```
public void onSessionResult(ISessionOperationResult result)
```
Description copied from interface: ISessionResultListener

Invoked each time a session event has been processed, successfully or not.

Specified by:

onSessionResult in interface ISessionResultListener

Parameters:

result - The result to be handled

onSessionError
```
public void onSessionError(SessionOperationException error)
```
Description copied from interface: ISessionResultListener

Invoked each time a session event has not been processed because session control raised an exception.

Specified by:

onSessionError in interface ISessionResultListener

Parameters:

error - The error to be handled

onResult

public void onResult(boolean reratingResult,
                     int fromSnapshotId,
                     java.util.Date fromDate)

Specified by:: onResult in interface BatchChargeEventListener

onResult
```
public void onResult(BatchChargeResult b)
```
Description copied from interface: BatchChargeEventListener

Invoked when the cleanup operation is successful.

Specified by:

onResult in interface BatchChargeEventListener

Parameters:

b - The result of the cleanup operation

onResult
```
public void onResult(java.util.List<AcquisitionResult> results)
```
Description copied from interface: AcquisitionListener

Invoked by the asynchronous batch service client when the SAP CC system returns the result of the AsyncBatchServiceClient.acquire(List, AcquisitionListener) method.

Specified by:

onResult in interface AcquisitionListener

Parameters:

results - A list of acquisition results, in the same order as the parameters specified as arguments of the method AsyncBatchServiceClient.acquire(List, AcquisitionListener) that was used to request the batch acquisition operation

onResult
```
public void onResult(IMonitorSpendingStatusResultListener.ISpendingStatusMonitoringResult spendingStatusMonitoringResult)
```
Description copied from interface: IMonitorSpendingStatusResultListener

Invoked each time a request of spending status monitoring has been processed successfully.

Specified by:

onResult in interface IMonitorSpendingStatusResultListener

Parameters:

spendingStatusMonitoringResult - The result to handle

onException
```
public void onException(BatchChargeException e)
```
Description copied from interface: BatchChargeEventListener

Invoked when the cleanup operation fails because of a batchChargeException.

Specified by:

onException in interface BatchChargeEventListener

Parameters:

e - The Batch Charge exception to be handled

onException
```
public void onException(RerateSubscriptionException e)
```
Description copied from interface: BatchChargeEventListener

Invoked when the rerating operation fails because of a RerateSubscriptionException.

Specified by:

onException in interface BatchChargeEventListener

Parameters:

e - The Rerate Subscription exception to be handled

waitForResponse

public void waitForResponse()
                     throws CommunicationFailureException

Throws:: CommunicationFailureException

getStartRateResult

public StartRateResult getStartRateResult()
                                   throws ServerFailureException,
                                          ForbiddenChargeException,
                                          InvalidItemException,
                                          TransactionClearingException,
                                          CommunicationFailureException,
                                          StartRateException

Throws:: ServerFailureException; ForbiddenChargeException; InvalidItemException; TransactionClearingException; CommunicationFailureException; StartRateException

getStopRateResult

public StopRateResult getStopRateResult()
                                 throws ServerFailureException,
                                        ForbiddenChargeException,
                                        InvalidItemException,
                                        TransactionClearingException,
                                        CommunicationFailureException,
                                        StopRateException

Throws:: ServerFailureException; ForbiddenChargeException; InvalidItemException; TransactionClearingException; CommunicationFailureException; StopRateException

getUpdateRateResult

public UpdateRateResult getUpdateRateResult()
                                     throws ServerFailureException,
                                            ForbiddenChargeException,
                                            InvalidItemException,
                                            TransactionClearingException,
                                            CommunicationFailureException,
                                            UpdateRateException

Throws:: ServerFailureException; ForbiddenChargeException; InvalidItemException; TransactionClearingException; CommunicationFailureException; UpdateRateException

getSessionResult

public ISessionOperationResult getSessionResult()
                                         throws CommunicationFailureException,
                                                ServerFailureException,
                                                java.lang.IllegalArgumentException,
                                                ForbiddenChargeException,
                                                SessionOperationException

Throws:: CommunicationFailureException; ServerFailureException; java.lang.IllegalArgumentException; ForbiddenChargeException; SessionOperationException

getTranslateResult

public java.lang.Object[] getTranslateResult()
                                      throws ServerFailureException,
                                             ForbiddenChargeException,
                                             InvalidItemException,
                                             TransactionClearingException,
                                             CommunicationFailureException,
                                             DoesNotExistException

Throws:: ServerFailureException; ForbiddenChargeException; InvalidItemException; TransactionClearingException; CommunicationFailureException; DoesNotExistException

getPreRateResult

public PreRateResult getPreRateResult()
                               throws CommunicationFailureException,
                                      PreRateException,
                                      ServerFailureException,
                                      ForbiddenChargeException,
                                      InvalidItemException,
                                      TransactionClearingException

Throws:: CommunicationFailureException; PreRateException; ServerFailureException; ForbiddenChargeException; InvalidItemException; TransactionClearingException

getPostRateResult

public PostRateResult getPostRateResult()
                                 throws ServerFailureException,
                                        ForbiddenChargeException,
                                        InvalidItemException,
                                        TransactionClearingException,
                                        CommunicationFailureException,
                                        PostRateException

Throws:: ServerFailureException; ForbiddenChargeException; InvalidItemException; TransactionClearingException; CommunicationFailureException; PostRateException

getCheckLimitResult

public CheckLimitResult getCheckLimitResult()
                                     throws CommunicationFailureException,
                                            CannotInverseException,
                                            ServerFailureException,
                                            ForbiddenChargeException,
                                            InvalidItemException,
                                            TransactionClearingException

Throws:: CommunicationFailureException; CannotInverseException; ServerFailureException; ForbiddenChargeException; InvalidItemException; TransactionClearingException

getCleanupResult

public CleanupResult getCleanupResult()
                               throws CleanupException,
                                      ServerFailureException,
                                      ForbiddenChargeException,
                                      TransactionClearingException,
                                      CommunicationFailureException

Throws:: CleanupException; ServerFailureException; ForbiddenChargeException; TransactionClearingException; CommunicationFailureException

getPurchaseOrder

public PurchaseOrder getPurchaseOrder()
                               throws CommunicationFailureException,
                                      ServerFailureException,
                                      ForbiddenChargeException,
                                      InvalidItemException,
                                      TransactionClearingException

Throws:: CommunicationFailureException; ServerFailureException; ForbiddenChargeException; InvalidItemException; TransactionClearingException

getChargingResult

public ChargingResult getChargingResult()
                                 throws CommunicationFailureException,
                                        ServerFailureException,
                                        ForbiddenChargeException,
                                        InvalidItemException,
                                        TransactionClearingException

Throws:: CommunicationFailureException; ServerFailureException; ForbiddenChargeException; InvalidItemException; TransactionClearingException

getActivateResult

public PurchaseOrder getActivateResult()
                                throws ServerFailureException,
                                       ForbiddenChargeException,
                                       TransactionClearingException,
                                       CommunicationFailureException,
                                       ActivateException

Throws:: ServerFailureException; ForbiddenChargeException; TransactionClearingException; CommunicationFailureException; ActivateException

getBatchChargeResult

public BatchChargeResult getBatchChargeResult()
                                       throws CommunicationFailureException,
                                              ForbiddenChargeException,
                                              ServerFailureException,
                                              BatchChargeException,
                                              TransactionClearingException

Throws:: CommunicationFailureException; ForbiddenChargeException; ServerFailureException; BatchChargeException; TransactionClearingException

getAcquisitionResults

public java.util.List<AcquisitionResult> getAcquisitionResults()
                                                        throws CommunicationFailureException,
                                                               ServerFailureException

Throws:: CommunicationFailureException; ServerFailureException

getInformStartSubscriptionRerating

public StartSubscriptionReratingResult getInformStartSubscriptionRerating()
                                                                   throws CommunicationFailureException,
                                                                          ServerFailureException,
                                                                          RerateSubscriptionException

Throws:: CommunicationFailureException; ServerFailureException; RerateSubscriptionException

getSpendingStatusMonitoringResult

public IMonitorSpendingStatusResultListener.ISpendingStatusMonitoringResult getSpendingStatusMonitoringResult()
                                                                                                       throws CommunicationFailureException,
                                                                                                              ServerFailureException,
                                                                                                              ForbiddenChargeException

Throws:: CommunicationFailureException; ServerFailureException; ForbiddenChargeException

getInformStopSubscriptionRerating

public boolean getInformStopSubscriptionRerating()
                                          throws CommunicationFailureException,
                                                 ForbiddenChargeException,
                                                 ServerFailureException,
                                                 TransactionClearingException

Throws:: CommunicationFailureException; ForbiddenChargeException; ServerFailureException; TransactionClearingException

pingReratingOperationResult

public boolean pingReratingOperationResult()
                                    throws CommunicationFailureException,
                                           ForbiddenChargeException,
                                           ServerFailureException,
                                           TransactionClearingException

Throws:: CommunicationFailureException; ForbiddenChargeException; ServerFailureException; TransactionClearingException

Class UniversalChargeEventListener

Nested Class Summary

Nested classes/interfaces inherited from interface com.highdeal.cnd.message.IMonitorSpendingStatusResultListener

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UniversalChargeEventListener

Method Detail

onResult

onResult

onException

onException

onException

onException

onException

onException

onException

onResult

onException

onResult

onException

onException

onResult

onResult

onException

onException

onResult

onException

onException

onException

onStartRateResult

onStopRateResult

onUpdateRateResult

onSessionResult

onSessionError

onResult

onResult

onResult

onResult

onException

onException

waitForResponse

getStartRateResult

getStopRateResult

getUpdateRateResult

getSessionResult

getTranslateResult

getPreRateResult

getPostRateResult

getCheckLimitResult

getCleanupResult

getPurchaseOrder

getChargingResult

getActivateResult

getBatchChargeResult

getAcquisitionResults

getInformStartSubscriptionRerating

getSpendingStatusMonitoringResult

getInformStopSubscriptionRerating

pingReratingOperationResult