Package com.highdeal.cnd.message
Class SessionOperationItemResult
java.lang.Object
com.highdeal.cnd.message.SessionOperationItemResult
- All Implemented Interfaces:
ISessionOperationItemResult
This class defines the result of a session-based charging operation.
This result can be a success or a failure.
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.highdeal.pnr.hci.ISessionOperationItemResult
ISessionOperationItemResult.SessionOperationItemResultStatus, ISessionOperationItemResult.SessionOperationItemResultType -
Method Summary
Modifier and TypeMethodDescriptionReturns the type of thisresult.final StartRateResultReturns the embeddedstart rate result, if available.final StopRateResultReturns the embeddedstop rate result, if available.final UpdateRateResultReturns the embeddedupdate rate result, if available.final booleanisError()Indicates if thisresultis an erroneous return.final booleanisReturn()Indicates if thisresultis a successful return.final voidsetStopRateResult(StopRateResult stopRateResult) Sets the embeddedstop rate result, if available.final voidThrows exception that must be caught when the result is erroneous and is of typeISessionOperationItemResult.SessionOperationItemResultType.START.final voidThrows exception that must be caught when the result is erroneous and is of typeISessionOperationItemResult.SessionOperationItemResultType.STOP.final voidThrows exception that must be caught when the result is erroneous and is of typeISessionOperationItemResult.SessionOperationItemResultType.UPDATE.
-
Method Details
-
isReturn
public final boolean isReturn()Indicates if thisresultis a successful return.- Specified by:
isReturnin interfaceISessionOperationItemResult- Returns:
- true if this result is a successful return.
- See Also:
-
isError
public final boolean isError()Indicates if thisresultis an erroneous return.- Specified by:
isErrorin interfaceISessionOperationItemResult- Returns:
- true if this result is a erroneous return.
- See Also:
-
getResultType
Returns the type of thisresult.- Specified by:
getResultTypein interfaceISessionOperationItemResult- Returns:
- the type of this result
- See Also:
-
getStartRateResult
Returns the embeddedstart rate result, if available.- Specified by:
getStartRateResultin interfaceISessionOperationItemResult- Returns:
- the embedded start rate result, or null.
-
getStopRateResult
Returns the embeddedstop rate result, if available.- Specified by:
getStopRateResultin interfaceISessionOperationItemResult- Returns:
- the embedded stop rate result, or null.
-
setStopRateResult
Sets the embeddedstop rate result, if available.- Parameters:
stopRateResult- the embedded stop rate result, or null.
-
getUpdateRateResult
Returns the embeddedupdate rate result, if available.- Specified by:
getUpdateRateResultin interfaceISessionOperationItemResult- Returns:
- the embedded update rate result, or null.
-
throwStartRateError
public final void throwStartRateError() throws StartRateException, InvalidItemException, ForbiddenChargeException, ServerFailureException, TransactionClearingException, CommunicationFailureExceptionThrows exception that must be caught when the result is erroneous and is of typeISessionOperationItemResult.SessionOperationItemResultType.START.- Specified by:
throwStartRateErrorin interfaceISessionOperationItemResult- Throws:
StartRateException- thrown if the cause of this erroneous result is a start rate exceptionInvalidItemException- thrown if the cause of this erroneous result is an invalid item exceptionForbiddenChargeException- thrown if the cause of this erroneous result is a forbidden charge exceptionServerFailureException- thrown if the cause of this erroneous result is a server failure exceptionTransactionClearingException- thrown if the cause of this erroneous result is a transaction clearing exceptionCommunicationFailureException- thrown if the cause of this erroneous result is a communication failure exception
-
throwStopRateError
public final void throwStopRateError() throws StopRateException, InvalidItemException, ForbiddenChargeException, ServerFailureException, TransactionClearingException, CommunicationFailureExceptionThrows exception that must be caught when the result is erroneous and is of typeISessionOperationItemResult.SessionOperationItemResultType.STOP.- Specified by:
throwStopRateErrorin interfaceISessionOperationItemResult- Throws:
StopRateException- thrown if the cause of this erroneous result is a stop rate exceptionInvalidItemException- thrown if the cause of this erroneous result is an invalid item exceptionForbiddenChargeException- thrown if the cause of this erroneous result is a forbidden charge exceptionServerFailureException- thrown if the cause of this erroneous result is a server failure exceptionTransactionClearingException- thrown if the cause of this erroneous result is a transaction clearing exceptionCommunicationFailureException- thrown if the cause of this erroneous result is a communication failure exception
-
throwUpdateRateError
public final void throwUpdateRateError() throws UpdateRateException, InvalidItemException, ForbiddenChargeException, ServerFailureException, TransactionClearingException, CommunicationFailureExceptionThrows exception that must be caught when the result is erroneous and is of typeISessionOperationItemResult.SessionOperationItemResultType.UPDATE.- Specified by:
throwUpdateRateErrorin interfaceISessionOperationItemResult- Throws:
UpdateRateException- thrown if the cause of this erroneous result is a update rate exceptionInvalidItemException- thrown if the cause of this erroneous result is an invalid item exceptionForbiddenChargeException- thrown if the cause of this erroneous result is a forbidden charge exceptionServerFailureException- thrown if the cause of this erroneous result is a server failure exceptionTransactionClearingException- thrown if the cause of this erroneous result is a transaction clearing exceptionCommunicationFailureException- thrown if the cause of this erroneous result is a communication failure exception
-