com.highdeal.cnd.message

Class SessionOperationItemResult

java.lang.Object

com.highdeal.cnd.message.SessionOperationItemResult

All Implemented Interfaces:

ISessionOperationItemResult

public class SessionOperationItemResult
extends Object
implements 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 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	setStopRateResult(StopRateResult stopRateResult) Sets the embedded stop rate result, if available.
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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isReturn

public final boolean isReturn()

Indicates if this result is a successful return.

Specified by:

isReturn in interface ISessionOperationItemResult

Returns:

true if this result is a successful return.

See Also:

isError()

isError

public final boolean isError()

Indicates if this result is an erroneous return.

Specified by:

isError in interface ISessionOperationItemResult

Returns:

true if this result is a erroneous return.

See Also:

isReturn()

getResultType

public final ISessionOperationItemResult.SessionOperationItemResultType getResultType()

Returns the type of this result.

Specified by:

getResultType in interface ISessionOperationItemResult

Returns:

the type of this result

See Also:

ISessionOperationItemResult.SessionOperationItemResultType

getStartRateResult

public final StartRateResult getStartRateResult()

Returns the embedded start rate result, if available.

Specified by:

getStartRateResult in interface ISessionOperationItemResult

Returns:

the embedded start rate result, or null.

getStopRateResult

public final StopRateResult getStopRateResult()

Returns the embedded stop rate result, if available.

Specified by:

getStopRateResult in interface ISessionOperationItemResult

Returns:

the embedded stop rate result, or null.

setStopRateResult

public final void setStopRateResult(StopRateResult stopRateResult)

Sets the embedded stop rate result, if available.

Parameters:

stopRateResult - the embedded stop rate result, or null.

getUpdateRateResult

public final UpdateRateResult getUpdateRateResult()

Returns the embedded update rate result, if available.

Specified by:

getUpdateRateResult in interface ISessionOperationItemResult

Returns:

the embedded update rate result, or null.

throwStartRateError

public final 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.

Specified by:

throwStartRateError in interface ISessionOperationItemResult

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

public final 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.

Specified by:

throwStopRateError in interface ISessionOperationItemResult

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

public final 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.

Specified by:

throwUpdateRateError in interface ISessionOperationItemResult

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