com.opencloud.slee.resources.cgin.cap_v3

Interface CAP3Dialog

All Superinterfaces:

CAP1Dialog, CAP2Dialog, CCDialog, Dialog

All Known Subinterfaces:

CAP4Dialog

public interface CAP3Dialog
extends CAP2Dialog

Protocol-specific extension interface for cap_v3 dialogs. Contains typesafe convenience methods for sending operation invokes, results, and errors.

Nested Class Summary

Nested classes/interfaces inherited from interface Dialog

Dialog.State

Field Summary

Fields inherited from interface Dialog

INVOKE_ID_UNSPECIFIED

Method Summary

Methods

Modifier and Type	Method and Description
int	sendActivityTestGPRS(long timeout) Issues an activityTestGPRS operation request on the dialog.
void	sendActivityTestGPRSResponse(int invokeId) Issues a (last) response to an activityTestGPRS operation on the dialog.
void	sendActivityTestGPRSResponse(int invokeId, boolean isLast) Issues a response to an activityTestGPRS operation on the dialog.
int	sendApplyChargingGPRS(CAP3ApplyChargingGPRSArg argument) Issues an applyChargingGPRS operation request on the dialog.
int	sendApplyChargingReportGPRS(long timeout, CAP3ApplyChargingReportGPRSArg argument) Issues an applyChargingReportGPRS operation request on the dialog.
void	sendApplyChargingReportGPRSResponse(int invokeId) Issues a (last) response to an applyChargingReportGPRS operation on the dialog.
void	sendApplyChargingReportGPRSResponse(int invokeId, boolean isLast) Issues a response to an applyChargingReportGPRS operation on the dialog.
int	sendCancelGPRS(CAP3CancelGPRSArg argument) Issues a cancelGPRS operation request on the dialog.
int	sendConnectGPRS(CAP3ConnectGPRSArg argument) Issues a connectGPRS operation request on the dialog.
int	sendConnectSMS(CAP3ConnectSMSArg argument) Issues a connectSMS operation request on the dialog.
int	sendContinueGPRS(CAP3ContinueGPRSArg argument) Issues a continueGPRS operation request on the dialog.
int	sendContinueSMS() Issues a continueSMS operation request on the dialog.
int	sendContinueWithArgument(CAP3ContinueWithArgumentArg argument) Issues a continueWithArgument operation request on the dialog.
int	sendEntityReleasedGPRS(long timeout, CAP3EntityReleasedGPRSArg argument) Issues an entityReleasedGPRS operation request on the dialog.
void	sendEntityReleasedGPRSResponse(int invokeId) Issues a (last) response to an entityReleasedGPRS operation on the dialog.
void	sendEntityReleasedGPRSResponse(int invokeId, boolean isLast) Issues a response to an entityReleasedGPRS operation on the dialog.
int	sendEventReportGPRS(long timeout, CAP3EventReportGPRSArg argument) Issues an eventReportGPRS operation request on the dialog.
void	sendEventReportGPRSResponse(int invokeId) Issues a (last) response to an eventReportGPRS operation on the dialog.
void	sendEventReportGPRSResponse(int invokeId, boolean isLast) Issues a response to an eventReportGPRS operation on the dialog.
int	sendEventReportSMS(CAP3EventReportSMSArg argument) Issues an eventReportSMS operation request on the dialog.
int	sendFurnishChargingInformationGPRS(CAP3FurnishChargingInformationGPRSArg argument) Issues a furnishChargingInformationGPRS operation request on the dialog.
int	sendFurnishChargingInformationSMS(CAP3FurnishChargingInformationSMSArg argument) Issues a furnishChargingInformationSMS operation request on the dialog.
int	sendInitialDPGPRS(CAP3InitialDPGPRSArg argument) Issues an initialDPGPRS operation request on the dialog.
int	sendInitialDPSMS(CAP3InitialDPSMSArg argument) Issues an initialDPSMS operation request on the dialog.
int	sendReleaseGPRS(CAP3ReleaseGPRSArg argument) Issues a releaseGPRS operation request on the dialog.
int	sendReleaseSMS(RPCause argument) Issues a releaseSMS operation request on the dialog.
int	sendRequestReportGPRSEvent(CAP3RequestReportGPRSEventArg argument) Issues a requestReportGPRSEvent operation request on the dialog.
int	sendRequestReportSMSEvent(CAP3RequestReportSMSEventArg argument) Issues a requestReportSMSEvent operation request on the dialog.
int	sendResetTimerGPRS(CAP3ResetTimerGPRSArg argument) Issues a resetTimerGPRS operation request on the dialog.
int	sendResetTimerSMS(CAP3ResetTimerSMSArg argument) Issues a resetTimerSMS operation request on the dialog.
int	sendSendChargingInformationGPRS(CAP3SendChargingInformationGPRSArg argument) Issues a sendChargingInformationGPRS operation request on the dialog.
void	sendUnknownPDPIDError(int invokeId) Issues an unknownPDPID error response for an operation on the dialog.

Methods inherited from interface CCDialog

sendActivityTest, sendActivityTestResponse, sendActivityTestResponse, sendApplyCharging, sendApplyChargingReport, sendAssistRequestInstructions, sendCallGap, sendCallInformationReport, sendCallInformationRequest, sendCancel, sendCancelFailedError, sendCancelledError, sendConnect, sendConnectToResource, sendContinue, sendDisconnectForwardConnection, sendEstablishTemporaryConnection, sendETCFailedError, sendEventReportBCSM, sendFurnishChargingInformation, sendImproperCallerResponseError, sendInitialDP, sendMissingCustomerRecordError, sendMissingParameterError, sendParameterOutOfRangeError, sendPlayAnnouncement, sendPromptAndCollectUserInformation, sendPromptAndCollectUserInformationResponse, sendPromptAndCollectUserInformationResponse, sendReleaseCall, sendRequestedInfoErrorError, sendRequestReportBCSMEvent, sendResetTimer, sendSendChargingInformation, sendSpecializedResourceReport, sendSystemFailureError, sendTaskRefusedError, sendUnavailableResourceError, sendUnexpectedComponentSequenceError, sendUnexpectedDataValueError, sendUnexpectedParameterError, sendUnknownLegIDError

Methods inherited from interface Dialog

acceptDialog, acceptDialog, equals, getApplicationContext, getApplicationContextName, getDialogID, getDialogState, getLocalTransactionID, getMTPPriority, getProvider, getRemoteTransactionID, getSCCPClass, getSCCPReturnOption, getTcapVersion, hashCode, isGeneratingComponentEvents, isGeneratingMessageEvents, isStateless, isUnidirectionalInbound, isWithPermission, refuseDialog, refuseDialog, refuseDialog, sendClose, sendDelimiter, sendDelimiter, sendError, sendInvoke, sendResult, sendUserAbort, sendUserAbortWithUserAbortInformation, setActivityTimeout, setMTPPriority, setRemoteAddress, setSCCPClass, setSCCPReturnOption, setTcapVersion, toString, useComponentEvents, useMessageEvents

Method Detail

sendActivityTestGPRS

int sendActivityTestGPRS(long timeout)
                         throws TooManyInvokesException,
                                ProtocolException

Issues an activityTestGPRS operation request on the dialog.

Parameters:

timeout - invoke timeout, in milliseconds; 0 uses the RA default

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendActivityTestGPRSResponse

void sendActivityTestGPRSResponse(int invokeId)
                                  throws ProtocolException

Issues a (last) response to an activityTestGPRS operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

Throws:

ProtocolException - if the RA was unable to send the response for some reason

sendActivityTestGPRSResponse

void sendActivityTestGPRSResponse(int invokeId,
                                boolean isLast)
                                  throws ProtocolException

Issues a response to an activityTestGPRS operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

isLast - if true, will be sent in a ResultLast, if false will be sent in a ResultNotLast

Throws:

ProtocolException - if the RA was unable to send the response for some reason

sendApplyChargingGPRS

int sendApplyChargingGPRS(CAP3ApplyChargingGPRSArg argument)
                          throws TooManyInvokesException,
                                 ProtocolException

Issues an applyChargingGPRS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendApplyChargingReportGPRS

int sendApplyChargingReportGPRS(long timeout,
                              CAP3ApplyChargingReportGPRSArg argument)
                                throws TooManyInvokesException,
                                       ProtocolException

Issues an applyChargingReportGPRS operation request on the dialog.

Parameters:

timeout - invoke timeout, in milliseconds; 0 uses the RA default

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendApplyChargingReportGPRSResponse

void sendApplyChargingReportGPRSResponse(int invokeId)
                                         throws ProtocolException

Issues a (last) response to an applyChargingReportGPRS operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

Throws:

ProtocolException - if the RA was unable to send the response for some reason

sendApplyChargingReportGPRSResponse

void sendApplyChargingReportGPRSResponse(int invokeId,
                                       boolean isLast)
                                         throws ProtocolException

Issues a response to an applyChargingReportGPRS operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

isLast - if true, will be sent in a ResultLast, if false will be sent in a ResultNotLast

Throws:

ProtocolException - if the RA was unable to send the response for some reason

sendCancelGPRS

int sendCancelGPRS(CAP3CancelGPRSArg argument)
                   throws TooManyInvokesException,
                          ProtocolException

Issues a cancelGPRS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendConnectGPRS

int sendConnectGPRS(CAP3ConnectGPRSArg argument)
                    throws TooManyInvokesException,
                           ProtocolException

Issues a connectGPRS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendConnectSMS

int sendConnectSMS(CAP3ConnectSMSArg argument)
                   throws TooManyInvokesException,
                          ProtocolException

Issues a connectSMS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendContinueGPRS

int sendContinueGPRS(CAP3ContinueGPRSArg argument)
                     throws TooManyInvokesException,
                            ProtocolException

Issues a continueGPRS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendContinueSMS

int sendContinueSMS()
                    throws TooManyInvokesException,
                           ProtocolException

Issues a continueSMS operation request on the dialog.

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendContinueWithArgument

int sendContinueWithArgument(CAP3ContinueWithArgumentArg argument)
                             throws TooManyInvokesException,
                                    ProtocolException

Issues a continueWithArgument operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendEntityReleasedGPRS

int sendEntityReleasedGPRS(long timeout,
                         CAP3EntityReleasedGPRSArg argument)
                           throws TooManyInvokesException,
                                  ProtocolException

Issues an entityReleasedGPRS operation request on the dialog.

Parameters:

timeout - invoke timeout, in milliseconds; 0 uses the RA default

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendEntityReleasedGPRSResponse

void sendEntityReleasedGPRSResponse(int invokeId)
                                    throws ProtocolException

Issues a (last) response to an entityReleasedGPRS operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

Throws:

ProtocolException - if the RA was unable to send the response for some reason

sendEntityReleasedGPRSResponse

void sendEntityReleasedGPRSResponse(int invokeId,
                                  boolean isLast)
                                    throws ProtocolException

Issues a response to an entityReleasedGPRS operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

isLast - if true, will be sent in a ResultLast, if false will be sent in a ResultNotLast

Throws:

ProtocolException - if the RA was unable to send the response for some reason

sendEventReportGPRS

int sendEventReportGPRS(long timeout,
                      CAP3EventReportGPRSArg argument)
                        throws TooManyInvokesException,
                               ProtocolException

Issues an eventReportGPRS operation request on the dialog.

Parameters:

timeout - invoke timeout, in milliseconds; 0 uses the RA default

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendEventReportGPRSResponse

void sendEventReportGPRSResponse(int invokeId)
                                 throws ProtocolException

Issues a (last) response to an eventReportGPRS operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

Throws:

ProtocolException - if the RA was unable to send the response for some reason

sendEventReportGPRSResponse

void sendEventReportGPRSResponse(int invokeId,
                               boolean isLast)
                                 throws ProtocolException

Issues a response to an eventReportGPRS operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

isLast - if true, will be sent in a ResultLast, if false will be sent in a ResultNotLast

Throws:

ProtocolException - if the RA was unable to send the response for some reason

sendEventReportSMS

int sendEventReportSMS(CAP3EventReportSMSArg argument)
                       throws TooManyInvokesException,
                              ProtocolException

Issues an eventReportSMS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendFurnishChargingInformationGPRS

int sendFurnishChargingInformationGPRS(CAP3FurnishChargingInformationGPRSArg argument)
                                       throws TooManyInvokesException,
                                              ProtocolException

Issues a furnishChargingInformationGPRS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendFurnishChargingInformationSMS

int sendFurnishChargingInformationSMS(CAP3FurnishChargingInformationSMSArg argument)
                                      throws TooManyInvokesException,
                                             ProtocolException

Issues a furnishChargingInformationSMS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendInitialDPGPRS

int sendInitialDPGPRS(CAP3InitialDPGPRSArg argument)
                      throws TooManyInvokesException,
                             ProtocolException

Issues an initialDPGPRS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendInitialDPSMS

int sendInitialDPSMS(CAP3InitialDPSMSArg argument)
                     throws TooManyInvokesException,
                            ProtocolException

Issues an initialDPSMS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendReleaseGPRS

int sendReleaseGPRS(CAP3ReleaseGPRSArg argument)
                    throws TooManyInvokesException,
                           ProtocolException

Issues a releaseGPRS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendReleaseSMS

int sendReleaseSMS(RPCause argument)
                   throws TooManyInvokesException,
                          ProtocolException

Issues a releaseSMS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendRequestReportGPRSEvent

int sendRequestReportGPRSEvent(CAP3RequestReportGPRSEventArg argument)
                               throws TooManyInvokesException,
                                      ProtocolException

Issues a requestReportGPRSEvent operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendRequestReportSMSEvent

int sendRequestReportSMSEvent(CAP3RequestReportSMSEventArg argument)
                              throws TooManyInvokesException,
                                     ProtocolException

Issues a requestReportSMSEvent operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendResetTimerGPRS

int sendResetTimerGPRS(CAP3ResetTimerGPRSArg argument)
                       throws TooManyInvokesException,
                              ProtocolException

Issues a resetTimerGPRS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendResetTimerSMS

int sendResetTimerSMS(CAP3ResetTimerSMSArg argument)
                      throws TooManyInvokesException,
                             ProtocolException

Issues a resetTimerSMS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendSendChargingInformationGPRS

int sendSendChargingInformationGPRS(CAP3SendChargingInformationGPRSArg argument)
                                    throws TooManyInvokesException,
                                           ProtocolException

Issues a sendChargingInformationGPRS operation request on the dialog.

Parameters:

argument - argument value

Returns:

TCAP invoke ID allocated for this operation

Throws:

TooManyInvokesException - if no free invoke id is available on this dialog

ProtocolException - if the RA was unable to send the invoke for some reason

sendUnknownPDPIDError

void sendUnknownPDPIDError(int invokeId)
                           throws ProtocolException

Issues an unknownPDPID error response for an operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

Throws:

ProtocolException - if the RA was unable to send the error response for some reason