com.highdeal.pnr.hci

Interface ISessionOperationItemResult

All Known Implementing Classes:

SessionOperationItemResult

public interface ISessionOperationItemResult

This interface defines the result of a session-based charging operation item. This result can be a success or a failure. The typical usage of this interface can be as follow, if result is a reference to an ISessionOperationItemResult:

 switch (result.getResultType()) {
 case START:
     if (result.isReturn()) {
         StartRateResult startResult = result.getStartRateResult();
         ....
     } else {
         try {
             result.throwStartRateError();
         } catch (StartRateException e) {
             ...
         } catch (InvalidItemException e) {
             ...
          } ... catch other exceptions thrown by the previous method
     }
     break;
 case UPDATE:
     if (result.isReturn()) {
         UpdateRateResult updateResult = result.getUpdateRateResult();
         ....
     } else {
         try {
             result.throwUpdateRateError();
         } catch (UpdateRateException e) {
             ...
         } catch (InvalidItemException e) {
             ...
          } ... catch other exceptions thrown by the previous method
     }
     break;
 case STOP:
     if (result.isReturn()) {
         StopRateResult stopResult = result.geStopRateResult();
         ....
     } else {
         try {
             result.throwStopRateError();
         } catch (StopRateException e) {
             ...
         } catch (InvalidItemException e) {
             ...
          } ... catch other exceptions thrown by the previous method
     }
     break;
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ISessionOperationItemResult.SessionOperationItemResultStatus The result status.
static class	ISessionOperationItemResult.SessionOperationItemResultType The type of the ISessionOperationItemResult.

Method Summary

Modifier and Type	Method and Description
ISessionOperationItemResult.SessionOperationItemResultType	getResultType() Returns the type of this result.
StartRateResult	getStartRateResult() Returns the embedded start rate result, if available.
StopRateResult	getStopRateResult() Returns the embedded stop rate result, if available.
UpdateRateResult	getUpdateRateResult() Returns the embedded update rate result, if available.
boolean	isError() Indicates if this result is an erroneous return.
boolean	isReturn() Indicates if this result is a successful return.
void	throwStartRateError() Throws exception that must be caught when the result is erroneous and is of type ISessionOperationItemResult.SessionOperationItemResultType.START.
void	throwStopRateError() Throws exception that must be caught when the result is erroneous and is of type ISessionOperationItemResult.SessionOperationItemResultType.STOP.
void	throwUpdateRateError() Throws exception that must be caught when the result is erroneous and is of type ISessionOperationItemResult.SessionOperationItemResultType.UPDATE.

Method Detail

isReturn

boolean isReturn()

Indicates if this result is a successful return.

Returns:

true if this result is a successful return, false if this is an error

See Also:

isError()

isError

boolean isError()

Indicates if this result is an erroneous return.

Returns:

true if this result is a erroneous return.

See Also:

isReturn()

getResultType

ISessionOperationItemResult.SessionOperationItemResultType getResultType()

Returns the type of this result.

Returns:

the type of this result

See Also:

ISessionOperationItemResult.SessionOperationItemResultType

getStartRateResult

StartRateResult getStartRateResult()

Returns the embedded start rate result, if available.

Returns:

the embedded start rate result, or null.

getStopRateResult

StopRateResult getStopRateResult()

Returns the embedded stop rate result, if available. In case ISessionConfirmAndReserve.prepareConfirmAndReserve(String, ChargeableItem, ChargeableItem) has been called and is an erroneous return, a StopRateResult is available in addition to the exception to determine either confirmation or reservation has failed.

Returns:

the embedded stop rate result, or null.

getUpdateRateResult

UpdateRateResult getUpdateRateResult()

Returns the embedded update rate result, if available.

Returns:

the embedded update rate result, or null.

throwStartRateError

void throwStartRateError()
                  throws StartRateException,
                         InvalidItemException,
                         ForbiddenChargeException,
                         ServerFailureException,
                         TransactionClearingException,
                         CommunicationFailureException

Throws exception that must be caught when the result is erroneous and is of type ISessionOperationItemResult.SessionOperationItemResultType.START.

Throws:

StartRateException - thrown if the cause of this erroneous result is a start rate exception

InvalidItemException - thrown if the cause of this erroneous result is an invalid item exception

ForbiddenChargeException - thrown if the cause of this erroneous result is a forbidden charge exception

ServerFailureException - thrown if the cause of this erroneous result is a server failure exception

TransactionClearingException - thrown if the cause of this erroneous result is a transaction clearing exception

CommunicationFailureException - thrown if the cause of this erroneous result is a communication failure exception

throwStopRateError

void throwStopRateError()
                 throws StopRateException,
                        InvalidItemException,
                        ForbiddenChargeException,
                        ServerFailureException,
                        TransactionClearingException,
                        CommunicationFailureException

Throws exception that must be caught when the result is erroneous and is of type ISessionOperationItemResult.SessionOperationItemResultType.STOP.

Throws:

StopRateException - thrown if the cause of this erroneous result is a stop rate exception

InvalidItemException - thrown if the cause of this erroneous result is an invalid item exception

ForbiddenChargeException - thrown if the cause of this erroneous result is a forbidden charge exception

ServerFailureException - thrown if the cause of this erroneous result is a server failure exception

TransactionClearingException - thrown if the cause of this erroneous result is a transaction clearing exception

CommunicationFailureException - thrown if the cause of this erroneous result is a communication failure exception

throwUpdateRateError

void throwUpdateRateError()
                   throws UpdateRateException,
                          InvalidItemException,
                          ForbiddenChargeException,
                          ServerFailureException,
                          TransactionClearingException,
                          CommunicationFailureException

Throws exception that must be caught when the result is erroneous and is of type ISessionOperationItemResult.SessionOperationItemResultType.UPDATE.

Throws:

UpdateRateException - thrown if the cause of this erroneous result is a update rate exception

InvalidItemException - thrown if the cause of this erroneous result is an invalid item exception

ForbiddenChargeException - thrown if the cause of this erroneous result is a forbidden charge exception

ServerFailureException - thrown if the cause of this erroneous result is a server failure exception

TransactionClearingException - thrown if the cause of this erroneous result is a transaction clearing exception

CommunicationFailureException - thrown if the cause of this erroneous result is a communication failure exception