Package com.opencloud.slee.resources.cgin.callcontrol

Interface CCDialog

All Superinterfaces:

Dialog

All Known Subinterfaces:

CAP1Dialog, CAP2Dialog, CAP3Dialog, CAP4Dialog, CS1Dialog

public interface CCDialog
extends Dialog

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.opencloud.slee.resources.cgin.Dialog

Dialog.State

Field Summary

Fields inherited from interface com.opencloud.slee.resources.cgin.Dialog

INVOKE_ID_UNSPECIFIED

Method Summary

Modifier and Type	Method	Description
int	sendActivityTest(long timeout)	Issues an activityTest operation request on the dialog.
void	sendActivityTestResponse(int invokeId)	Issues a (last) response to an activityTest operation on the dialog.
void	sendActivityTestResponse(int invokeId, boolean isLast)	Issues a response to an activityTest operation on the dialog.
int	sendApplyCharging(CCApplyChargingArg argument)	Issues an applyCharging operation request on the dialog.
int	sendApplyChargingReport(CCApplyChargingReportArg argument)	Issues an applyChargingReport operation request on the dialog.
int	sendAssistRequestInstructions(CCAssistRequestInstructionsArg argument)	Issues an assistRequestInstructions operation request on the dialog.
int	sendCallGap(CCCallGapArg argument)	Issues a callGap operation request on the dialog.
int	sendCallInformationReport(CCCallInformationReportArg argument)	Issues a callInformationReport operation request on the dialog.
int	sendCallInformationRequest(CCCallInformationRequestArg argument)	Issues a callInformationRequest operation request on the dialog.
int	sendCancel(CCCancelArg argument)	Issues a cancel operation request on the dialog.
void	sendCancelFailedError(int invokeId, CCCancelFailedArg error)	Issues a cancelFailed error response for an operation on the dialog.
void	sendCancelledError(int invokeId)	Issues a cancelled error response for an operation on the dialog.
int	sendConnect(CCConnectArg argument)	Issues a connect operation request on the dialog.
int	sendConnectToResource(CCConnectToResourceArg argument)	Issues a connectToResource operation request on the dialog.
int	sendContinue()	Issues a continue operation request on the dialog.
int	sendDisconnectForwardConnection()	Issues a disconnectForwardConnection operation request on the dialog.
int	sendEstablishTemporaryConnection(CCEstablishTemporaryConnectionArg argument)	Issues an establishTemporaryConnection operation request on the dialog.
void	sendETCFailedError(int invokeId)	Issues an eTCFailed error response for an operation on the dialog.
int	sendEventReportBCSM(CCEventReportBCSMArg argument)	Issues an eventReportBCSM operation request on the dialog.
int	sendFurnishChargingInformation(CCFurnishChargingInformationArg argument)	Issues a furnishChargingInformation operation request on the dialog.
void	sendImproperCallerResponseError(int invokeId)	Issues an improperCallerResponse error response for an operation on the dialog.
int	sendInitialDP(CCInitialDPArg argument)	Issues an initialDP operation request on the dialog.
void	sendMissingCustomerRecordError(int invokeId)	Issues a missingCustomerRecord error response for an operation on the dialog.
void	sendMissingParameterError(int invokeId)	Issues a missingParameter error response for an operation on the dialog.
void	sendParameterOutOfRangeError(int invokeId)	Issues a parameterOutOfRange error response for an operation on the dialog.
int	sendPlayAnnouncement(long timeout, CCPlayAnnouncementArg argument)	Issues a playAnnouncement operation request on the dialog.
int	sendPromptAndCollectUserInformation(long timeout, CCPromptAndCollectUserInformationArg argument)	Issues a promptAndCollectUserInformation operation request on the dialog.
void	sendPromptAndCollectUserInformationResponse(int invokeId, CCReceivedInformationArg result)	Issues a (last) response to a promptAndCollectUserInformation operation on the dialog.
void	sendPromptAndCollectUserInformationResponse(int invokeId, CCReceivedInformationArg result, boolean isLast)	Issues a response to a promptAndCollectUserInformation operation on the dialog.
int	sendReleaseCall(CCReleaseCallArg argument)	Issues a releaseCall operation request on the dialog.
void	sendRequestedInfoErrorError(int invokeId, CCRequestedInfoErrorArg error)	Issues a requestedInfoError error response for an operation on the dialog.
int	sendRequestReportBCSMEvent(CCRequestReportBCSMEventArg argument)	Issues a requestReportBCSMEvent operation request on the dialog.
int	sendResetTimer(CCResetTimerArg argument)	Issues a resetTimer operation request on the dialog.
int	sendSendChargingInformation(CCSendChargingInformationArg argument)	Issues a sendChargingInformation operation request on the dialog.
int	sendSpecializedResourceReport(int linkedId, CCSpecializedResourceReportArg argument)	Issues a specializedResourceReport operation request on the dialog.
void	sendSystemFailureError(int invokeId, CCUnavailableNetworkResource error)	Issues a systemFailure error response for an operation on the dialog.
void	sendTaskRefusedError(int invokeId, CCTaskRefusedArg error)	Issues a taskRefused error response for an operation on the dialog.
void	sendUnavailableResourceError(int invokeId)	Issues an unavailableResource error response for an operation on the dialog.
void	sendUnexpectedComponentSequenceError(int invokeId)	Issues an unexpectedComponentSequence error response for an operation on the dialog.
void	sendUnexpectedDataValueError(int invokeId)	Issues an unexpectedDataValue error response for an operation on the dialog.
void	sendUnexpectedParameterError(int invokeId)	Issues an unexpectedParameter error response for an operation on the dialog.
void	sendUnknownLegIDError(int invokeId)	Issues an unknownLegID error response for an operation on the dialog.

Methods inherited from interface com.opencloud.slee.resources.cgin.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

sendActivityTest

int sendActivityTest(long timeout)
              throws TooManyInvokesException,
                     ProtocolException

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

sendActivityTestResponse

void sendActivityTestResponse(int invokeId)
                       throws ProtocolException

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

sendActivityTestResponse

void sendActivityTestResponse(int invokeId,
                              boolean isLast)
                       throws ProtocolException

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

sendApplyCharging

int sendApplyCharging(CCApplyChargingArg argument)
               throws TooManyInvokesException,
                      ProtocolException

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

sendApplyChargingReport

int sendApplyChargingReport(CCApplyChargingReportArg argument)
                     throws TooManyInvokesException,
                            ProtocolException

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

sendAssistRequestInstructions

int sendAssistRequestInstructions(CCAssistRequestInstructionsArg argument)
                           throws TooManyInvokesException,
                                  ProtocolException

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

sendCallGap

int sendCallGap(CCCallGapArg argument)
         throws TooManyInvokesException,
                ProtocolException

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

sendCallInformationReport

int sendCallInformationReport(CCCallInformationReportArg argument)
                       throws TooManyInvokesException,
                              ProtocolException

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

sendCallInformationRequest

int sendCallInformationRequest(CCCallInformationRequestArg argument)
                        throws TooManyInvokesException,
                               ProtocolException

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

sendCancel

int sendCancel(CCCancelArg argument)
        throws TooManyInvokesException,
               ProtocolException

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

sendCancelFailedError

void sendCancelFailedError(int invokeId,
                           CCCancelFailedArg error)
                    throws ProtocolException

Issues a cancelFailed error response for an operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

error - parameter value

Throws:

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

sendCancelledError

void sendCancelledError(int invokeId)
                 throws ProtocolException

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

sendConnect

int sendConnect(CCConnectArg argument)
         throws TooManyInvokesException,
                ProtocolException

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

sendConnectToResource

int sendConnectToResource(CCConnectToResourceArg argument)
                   throws TooManyInvokesException,
                          ProtocolException

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

sendContinue

int sendContinue()
          throws TooManyInvokesException,
                 ProtocolException

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

sendDisconnectForwardConnection

int sendDisconnectForwardConnection()
                             throws TooManyInvokesException,
                                    ProtocolException

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

sendETCFailedError

void sendETCFailedError(int invokeId)
                 throws ProtocolException

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

sendEstablishTemporaryConnection

int sendEstablishTemporaryConnection(CCEstablishTemporaryConnectionArg argument)
                              throws TooManyInvokesException,
                                     ProtocolException

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

sendEventReportBCSM

int sendEventReportBCSM(CCEventReportBCSMArg argument)
                 throws TooManyInvokesException,
                        ProtocolException

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

sendFurnishChargingInformation

int sendFurnishChargingInformation(CCFurnishChargingInformationArg argument)
                            throws TooManyInvokesException,
                                   ProtocolException

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

sendImproperCallerResponseError

void sendImproperCallerResponseError(int invokeId)
                              throws ProtocolException

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

sendInitialDP

int sendInitialDP(CCInitialDPArg argument)
           throws TooManyInvokesException,
                  ProtocolException

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

sendMissingCustomerRecordError

void sendMissingCustomerRecordError(int invokeId)
                             throws ProtocolException

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

sendMissingParameterError

void sendMissingParameterError(int invokeId)
                        throws ProtocolException

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

sendParameterOutOfRangeError

void sendParameterOutOfRangeError(int invokeId)
                           throws ProtocolException

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

sendPlayAnnouncement

int sendPlayAnnouncement(long timeout,
                         CCPlayAnnouncementArg argument)
                  throws TooManyInvokesException,
                         ProtocolException

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

sendPromptAndCollectUserInformation

int sendPromptAndCollectUserInformation(long timeout,
                                        CCPromptAndCollectUserInformationArg argument)
                                 throws TooManyInvokesException,
                                        ProtocolException

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

sendPromptAndCollectUserInformationResponse

void sendPromptAndCollectUserInformationResponse(int invokeId,
                                                 CCReceivedInformationArg result)
                                          throws ProtocolException

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

sendPromptAndCollectUserInformationResponse

void sendPromptAndCollectUserInformationResponse(int invokeId,
                                                 CCReceivedInformationArg result,
                                                 boolean isLast)
                                          throws ProtocolException

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

sendReleaseCall

int sendReleaseCall(CCReleaseCallArg argument)
             throws TooManyInvokesException,
                    ProtocolException

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

sendRequestReportBCSMEvent

int sendRequestReportBCSMEvent(CCRequestReportBCSMEventArg argument)
                        throws TooManyInvokesException,
                               ProtocolException

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

sendRequestedInfoErrorError

void sendRequestedInfoErrorError(int invokeId,
                                 CCRequestedInfoErrorArg error)
                          throws ProtocolException

Issues a requestedInfoError error response for an operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

error - parameter value

Throws:

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

sendResetTimer

int sendResetTimer(CCResetTimerArg argument)
            throws TooManyInvokesException,
                   ProtocolException

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

sendSendChargingInformation

int sendSendChargingInformation(CCSendChargingInformationArg argument)
                         throws TooManyInvokesException,
                                ProtocolException

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

sendSpecializedResourceReport

int sendSpecializedResourceReport(int linkedId,
                                  CCSpecializedResourceReportArg argument)
                           throws TooManyInvokesException,
                                  ProtocolException

Issues a specializedResourceReport operation request on the dialog.

Parameters:

linkedId - linked invoke id

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

sendSystemFailureError

void sendSystemFailureError(int invokeId,
                            CCUnavailableNetworkResource error)
                     throws ProtocolException

Issues a systemFailure error response for an operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

error - parameter value

Throws:

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

sendTaskRefusedError

void sendTaskRefusedError(int invokeId,
                          CCTaskRefusedArg error)
                   throws ProtocolException

Issues a taskRefused error response for an operation on the dialog.

Parameters:

invokeId - TCAP invoke ID for the operation

error - parameter value

Throws:

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

sendUnavailableResourceError

void sendUnavailableResourceError(int invokeId)
                           throws ProtocolException

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

sendUnexpectedComponentSequenceError

void sendUnexpectedComponentSequenceError(int invokeId)
                                   throws ProtocolException

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

sendUnexpectedDataValueError

void sendUnexpectedDataValueError(int invokeId)
                           throws ProtocolException

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

sendUnexpectedParameterError

void sendUnexpectedParameterError(int invokeId)
                           throws ProtocolException

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

sendUnknownLegIDError

void sendUnknownLegIDError(int invokeId)
                    throws ProtocolException

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