SAP CC 1.0
API 4.2 (Core)

com.highdeal.cnd.message
Class AbstractStatefulServiceClient.UniversalChargeEventListener

java.lang.Object
  extended by com.highdeal.cnd.message.AbstractStatefulServiceClient.UniversalChargeEventListener
All Implemented Interfaces:
ActivateEventListener, BatchChargeEventListener, ChargeEventListener, ChargeExceptionListener, CheckLimitEventListener, CleanupEventListener, ExportSubscriberSubsDataEventListener, InvalidItemListener, PrePostRateEventListener, SessionEventListener, TranslateEventListener
Enclosing class:
AbstractStatefulServiceClient

protected static final class AbstractStatefulServiceClient.UniversalChargeEventListener
extends java.lang.Object
implements ChargeEventListener, CleanupEventListener, CheckLimitEventListener, PrePostRateEventListener, ActivateEventListener, TranslateEventListener, SessionEventListener, ExportSubscriberSubsDataEventListener, BatchChargeEventListener


Constructor Summary
AbstractStatefulServiceClient.UniversalChargeEventListener(int timeout)
           
 
Method Summary
 PurchaseOrder getActivateResult()
           
 BatchChargeResult getBatchChargeResult()
           
 CheckLimitResult getCheckLimitResult()
           
 CleanupResult getCleanupResult()
           
 ExportSubscriberSubsDataResult getExportSubscriberSubsDataResult()
           
 boolean getInformUnlockSubscription()
           
 PostRateResult getPostRateResult()
           
 PreRateResult getPreRateResult()
           
 PurchaseOrder getPurchaseOrder()
           
 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(ExportSubscriberSubsDataException e)
          Invoked if the server cannot retrieve the subscription or if a parameter operation is malformed.
 void onException(ForbiddenChargeException e)
          Invoked if the server cannot retrieve the subscription or if a parameter operation is malformed.
 void onException(java.lang.IllegalArgumentException e)
          Invoked when an argument of an operation is invalid.
 void onException(InvalidItemException e)
          Invoked when a chargeable item is invalid.
 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(ServerFailureException e)
          Invoked when the rater can not handle the 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)
           
 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(ExportSubscriberSubsDataResult result)
          Invoked when the exportSubscriberSubsData operation is successful.
 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 activate operation is successful.
 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractStatefulServiceClient.UniversalChargeEventListener

public AbstractStatefulServiceClient.UniversalChargeEventListener(int timeout)
Method Detail

onResult

public void onResult(PurchaseOrder order)
Description copied from interface: ActivateEventListener
Invoked when the activate operation is successful.

Specified by:
onResult in interface ActivateEventListener
Specified by:
onResult in interface ChargeEventListener
Parameters:
order - the related purchase order which will contain the list of generated transactions (if required and if some transactions exist)- one shot and recurring ones -. However, the purchase order will contain the total of generated amounts and the state of the purchase.

onException

public void onException(TransactionClearingException e)
Description copied from interface: ActivateEventListener
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 CheckLimitEventListener
Specified by:
onException in interface CleanupEventListener
Specified by:
onException in interface PrePostRateEventListener
Specified by:
onException in interface SessionEventListener
Parameters:
e - the exception to be handled.

onException

public void onException(java.lang.IllegalArgumentException e)
Description copied from interface: ChargeExceptionListener
Invoked when an argument of an operation 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 is invalid.

Specified by:
onException in interface InvalidItemListener
Specified by:
onException in interface SessionEventListener
Parameters:
e - the exception to be handled.

onException

public void onException(ForbiddenChargeException e)
Description copied from interface: ActivateEventListener
Invoked if the server cannot retrieve the subscription or if a parameter operation is malformed.

Specified by:
onException in interface ActivateEventListener
Specified by:
onException in interface BatchChargeEventListener
Specified by:
onException in interface ChargeEventListener
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 exception to be handled.

onException

public void onException(ServerFailureException e)
Description copied from interface: ChargeExceptionListener
Invoked when the rater can not handle the 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.

onException

public void onException(ExportSubscriberSubsDataException e)
Description copied from interface: ExportSubscriberSubsDataEventListener
Invoked if the server cannot retrieve the subscription or if a parameter operation is malformed.

Specified by:
onException in interface ExportSubscriberSubsDataEventListener
Parameters:
e - the exception to be handled.

onResult

public void onResult(ExportSubscriberSubsDataResult result)
Description copied from interface: ExportSubscriberSubsDataEventListener
Invoked when the exportSubscriberSubsData operation is successful.

Specified by:
onResult in interface ExportSubscriberSubsDataEventListener
Parameters:
result - the related ExportSubscriberSubsData result which will contain the list of generated subsReflect (if required)

onResult

public void onResult(boolean reratingResult)
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.

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 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

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

getActivateResult

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

getExportSubscriberSubsDataResult

public ExportSubscriberSubsDataResult getExportSubscriberSubsDataResult()
                                                                 throws CommunicationFailureException,
                                                                        ExportSubscriberSubsDataException
Throws:
CommunicationFailureException
ExportSubscriberSubsDataException

getBatchChargeResult

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

getInformUnlockSubscription

public boolean getInformUnlockSubscription()
                                    throws CommunicationFailureException,
                                           ForbiddenChargeException,
                                           ServerFailureException,
                                           TransactionClearingException
Throws:
CommunicationFailureException
ForbiddenChargeException
ServerFailureException
TransactionClearingException

pingReratingOperationResult

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

SAP CC 1.0
API 4.2 (Core)


API Reference - July 2009

SAP Convergent Charging 1.0 (build R4.2.1.35.0.0)
CONVERGENT CHARGING 4.2

(c) Copyright 2009 SAP AG. All rights reserved.