com.opencloud.slee.resources.cgin.cap_v4

Interface CAP4Dialog

All Superinterfaces:

CAP1Dialog, CAP2Dialog, CAP3Dialog, CCDialog, Dialog

public interface CAP4Dialog
extends CAP3Dialog

Protocol-specific extension interface for cap_v4 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	sendCollectInformation(CAP4CollectInformationArg argument) Issues a collectInformation operation request on the dialog.
int	sendDisconnectForwardConnectionWithArgument(CAP4DisconnectForwardConnectionWithArgumentArg argument) Issues a disconnectForwardConnectionWithArgument operation request on the dialog.
int	sendDisconnectLeg(long timeout, CAP4DisconnectLegArg argument) Issues a disconnectLeg operation request on the dialog.
void	sendDisconnectLegResponse(int invokeId) Issues a (last) response to a disconnectLeg operation on the dialog.
void	sendDisconnectLegResponse(int invokeId, boolean isLast) Issues a response to a disconnectLeg operation on the dialog.
int	sendEntityReleased(CAP4EntityReleasedArg argument) Issues an entityReleased operation request on the dialog.
int	sendInitiateCallAttempt(long timeout, CAP4InitiateCallAttemptArg argument) Issues an initiateCallAttempt operation request on the dialog.
void	sendInitiateCallAttemptResponse(int invokeId, CAP4InitiateCallAttemptRes result) Issues a (last) response to an initiateCallAttempt operation on the dialog.
void	sendInitiateCallAttemptResponse(int invokeId, CAP4InitiateCallAttemptRes result, boolean isLast) Issues a response to an initiateCallAttempt operation on the dialog.
int	sendMoveLeg(long timeout, CAP4MoveLegArg argument) Issues a moveLeg operation request on the dialog.
void	sendMoveLegResponse(int invokeId) Issues a (last) response to a moveLeg operation on the dialog.
void	sendMoveLegResponse(int invokeId, boolean isLast) Issues a response to a moveLeg operation on the dialog.
int	sendPlayTone(CAP4PlayToneArg argument) Issues a playTone operation request on the dialog.
int	sendSplitLeg(long timeout, CAP4SplitLegArg argument) Issues a splitLeg operation request on the dialog.
void	sendSplitLegResponse(int invokeId) Issues a (last) response to a splitLeg operation on the dialog.
void	sendSplitLegResponse(int invokeId, boolean isLast) Issues a response to a splitLeg operation on the dialog.
void	sendUnknownCSIDError(int invokeId) Issues an unknownCSID error response for an operation on the dialog.

Methods inherited from interface CAP3Dialog

sendActivityTestGPRS, sendActivityTestGPRSResponse, sendActivityTestGPRSResponse, sendApplyChargingGPRS, sendApplyChargingReportGPRS, sendApplyChargingReportGPRSResponse, sendApplyChargingReportGPRSResponse, sendCancelGPRS, sendConnectGPRS, sendConnectSMS, sendContinueGPRS, sendContinueSMS, sendContinueWithArgument, sendEntityReleasedGPRS, sendEntityReleasedGPRSResponse, sendEntityReleasedGPRSResponse, sendEventReportGPRS, sendEventReportGPRSResponse, sendEventReportGPRSResponse, sendEventReportSMS, sendFurnishChargingInformationGPRS, sendFurnishChargingInformationSMS, sendInitialDPGPRS, sendInitialDPSMS, sendReleaseGPRS, sendReleaseSMS, sendRequestReportGPRSEvent, sendRequestReportSMSEvent, sendResetTimerGPRS, sendResetTimerSMS, sendSendChargingInformationGPRS, sendUnknownPDPIDError

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

sendCollectInformation

int sendCollectInformation(CAP4CollectInformationArg argument)
                           throws TooManyInvokesException,
                                  ProtocolException

Issues a collectInformation 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

sendDisconnectForwardConnectionWithArgument

int sendDisconnectForwardConnectionWithArgument(CAP4DisconnectForwardConnectionWithArgumentArg argument)
                                                throws TooManyInvokesException,
                                                       ProtocolException

Issues a disconnectForwardConnectionWithArgument 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

sendDisconnectLeg

int sendDisconnectLeg(long timeout,
                    CAP4DisconnectLegArg argument)
                      throws TooManyInvokesException,
                             ProtocolException

Issues a disconnectLeg 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

sendDisconnectLegResponse

void sendDisconnectLegResponse(int invokeId)
                               throws ProtocolException

Issues a (last) response to a disconnectLeg 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

sendDisconnectLegResponse

void sendDisconnectLegResponse(int invokeId,
                             boolean isLast)
                               throws ProtocolException

Issues a response to a disconnectLeg 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

sendEntityReleased

int sendEntityReleased(CAP4EntityReleasedArg argument)
                       throws TooManyInvokesException,
                              ProtocolException

Issues an entityReleased 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

sendInitiateCallAttempt

int sendInitiateCallAttempt(long timeout,
                          CAP4InitiateCallAttemptArg argument)
                            throws TooManyInvokesException,
                                   ProtocolException

Issues an initiateCallAttempt 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

sendInitiateCallAttemptResponse

void sendInitiateCallAttemptResponse(int invokeId,
                                   CAP4InitiateCallAttemptRes result)
                                     throws ProtocolException

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

Parameters:

invokeId - TCAP invoke ID for the operation

result - result value

Throws:

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

sendInitiateCallAttemptResponse

void sendInitiateCallAttemptResponse(int invokeId,
                                   CAP4InitiateCallAttemptRes result,
                                   boolean isLast)
                                     throws ProtocolException

Issues a response to an initiateCallAttempt operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

result - result value

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

sendMoveLeg

int sendMoveLeg(long timeout,
              CAP4MoveLegArg argument)
                throws TooManyInvokesException,
                       ProtocolException

Issues a moveLeg 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

sendMoveLegResponse

void sendMoveLegResponse(int invokeId)
                         throws ProtocolException

Issues a (last) response to a moveLeg 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

sendMoveLegResponse

void sendMoveLegResponse(int invokeId,
                       boolean isLast)
                         throws ProtocolException

Issues a response to a moveLeg 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

sendPlayTone

int sendPlayTone(CAP4PlayToneArg argument)
                 throws TooManyInvokesException,
                        ProtocolException

Issues a playTone 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

sendSplitLeg

int sendSplitLeg(long timeout,
               CAP4SplitLegArg argument)
                 throws TooManyInvokesException,
                        ProtocolException

Issues a splitLeg 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

sendSplitLegResponse

void sendSplitLegResponse(int invokeId)
                          throws ProtocolException

Issues a (last) response to a splitLeg 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

sendSplitLegResponse

void sendSplitLegResponse(int invokeId,
                        boolean isLast)
                          throws ProtocolException

Issues a response to a splitLeg 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

sendUnknownCSIDError

void sendUnknownCSIDError(int invokeId)
                          throws ProtocolException

Issues an unknownCSID 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