public interface INSCSEvent extends SCSEvent
Modifier and Type | Method and Description |
---|---|
void |
failWithInvoke(TcapOperation operation,
Object arg,
boolean abortDialog)
Deprecated.
use
terminateWithInvoke(TcapOperation, Object, DialogTerminationPrimitive, boolean)
instead, which provides the same functionality but allows you to indicate
whether or not to record the result in statistics as a reject. |
void |
failWithRedirect(String iddPrefix,
String countryCode,
String redirectPrefix,
boolean abortDialog)
Deprecated.
use
terminateWithRedirect(String, String, String, DialogTerminationPrimitive, boolean)
instead, which provides the same functionality but allows you to indicate
whether or not to record the result in statistics as a reject. |
void |
failWithUserError(TcapError error,
Object parameter,
boolean abortDialog)
Deprecated.
use
terminateWithUserError(TcapError, Object, DialogTerminationPrimitive, boolean)
instead, which provides the same functionality but allows you to indicate
whether or not to record the result in statistics as a reject. |
DialogOpenRequestEvent |
getOpenRequest()
Get the open request received from the network.
|
void |
terminateWithInvoke(TcapOperation operation,
Object arg,
DialogTerminationPrimitive dialogTerminationPrimitive,
boolean recordAsReject)
Notify the SIS that trigger evaluation should be terminated for the initial request
event.
|
void |
terminateWithRedirect(String iddPrefix,
String countryCode,
String redirectPrefix,
DialogTerminationPrimitive dialogTerminationPrimitive,
boolean recordAsReject)
Notify the SIS that trigger evaluation should be terminated for the initial request
event.
|
void |
terminateWithUserError(TcapError error,
Object parameter,
DialogTerminationPrimitive dialogTerminationPrimitive,
boolean recordAsReject)
Notify the SIS that trigger evaluation should be terminated for the initial request
event.
|
compositionNotFound, compositionSelected, getRequest
DialogOpenRequestEvent getOpenRequest()
DialogMessageEvent.getComponentEvents()
.void terminateWithInvoke(TcapOperation operation, Object arg, DialogTerminationPrimitive dialogTerminationPrimitive, boolean recordAsReject) throws NullPointerException, IllegalArgumentException, IllegalStateException
Only the following types of operations may be invoked using this method:
operation
- a metadata object identifying the operation to invoke.arg
- the operation argument, or null
if there is no argumentdialogTerminationPrimitive
- indicates how the network dialog should be terminated
after the invoke operation has been sent.recordAsReject
- if true
the SIS will record this result in statistics
as a rejected dialog. If false
no reject statistics will be recorded.NullPointerException
- if operation
or dialogTerminationPrimitive
is null
.IllegalArgumentException
- if the specified operation is not a valid connect,
continue, or release response for the dialog, or the argument is not appropriate
for the operation.IllegalStateException
- if the service has already returned a response
to the SIS for this event. This exception may also be thrown if
the service takes too long to respond to the request and a timeout
has occurred in the SIS.void terminateWithUserError(TcapError error, Object parameter, DialogTerminationPrimitive dialogTerminationPrimitive, boolean recordAsReject) throws NullPointerException, IllegalStateException
error
- a metadata object identifying the User Error result to send.parameter
- the error parameter, or null
if there is no associated parameter.dialogTerminationPrimitive
- indicates how the network dialog should be terminated
after the User Error response has been sent.recordAsReject
- if true
the SIS will record this result in statistics
as a rejected dialog. If false
no reject statistics will be recorded.NullPointerException
- if error
or dialogTerminationPrimitive
is null
.IllegalStateException
- if the service has already returned a response
to the SIS for this event. This exception may also be thrown if
the service takes too long to respond to the request and a timeout
has occurred in the SIS.void terminateWithRedirect(String iddPrefix, String countryCode, String redirectPrefix, DialogTerminationPrimitive dialogTerminationPrimitive, boolean recordAsReject) throws NullPointerException, IllegalStateException
The Redirect behaviour applied is as follows:
iddPrefix
- the IDD prefix used by the Redirect logic to convert addresses to
national format.countryCode
- the country code used by the Redirect logic to convert addresses
to national format.redirectPrefix
- the redirect prefix added by the Redirect logic.dialogTerminationPrimitive
- indicates how the network dialog should be terminated
after the Redirect response has been sent.recordAsReject
- if true
the SIS will record this result in statistics
as a rejected dialog. If false
no reject statistics will be recorded.NullPointerException
- if any argument is null
.IllegalStateException
- if the service has already returned a response
to the SIS for this event. This exception may also be thrown if
the service takes too long to respond to the request and a timeout
has occurred in the SIS.@Deprecated void failWithInvoke(TcapOperation operation, Object arg, boolean abortDialog) throws NullPointerException, IllegalArgumentException, IllegalStateException
terminateWithInvoke(TcapOperation, Object, DialogTerminationPrimitive, boolean)
instead, which provides the same functionality but allows you to indicate
whether or not to record the result in statistics as a reject.Only the following types of operations may be invoked using this method:
operation
- a metadata object identifying the operation to invoke.arg
- the operation argument, or null
if there is no argumentabortDialog
- if true
the network dialog will be terminated
with a User Abort after the response has been sent. If false
the dialog will be terminated with a Close using a basic end.NullPointerException
- if operation
is null
.IllegalArgumentException
- if the specified operation is not a valid connect,
continue, or release response for the dialog, or the argument is not appropriate
for the operation.IllegalStateException
- if the service has already returned a response
to the SIS for this event. This exception may also be thrown if
the service takes too long to respond to the request and a timeout
has occurred in the SIS.@Deprecated void failWithUserError(TcapError error, Object parameter, boolean abortDialog) throws NullPointerException, IllegalStateException
terminateWithUserError(TcapError, Object, DialogTerminationPrimitive, boolean)
instead, which provides the same functionality but allows you to indicate
whether or not to record the result in statistics as a reject.error
- a metadata object identifying the error to send.parameter
- the error parameter, or null
if there is no associated
parameter.abortDialog
- if true
the network dialog will be terminated
with a User Abort after the response has been sent. If false
the dialog will be terminated with a Close using a basic end.NullPointerException
- if error
is null
.IllegalStateException
- if the service has already returned a response
to the SIS for this event. This exception may also be thrown if
the service takes too long to respond to the request and a timeout
has occurred in the SIS.@Deprecated void failWithRedirect(String iddPrefix, String countryCode, String redirectPrefix, boolean abortDialog) throws NullPointerException, IllegalStateException
terminateWithRedirect(String, String, String, DialogTerminationPrimitive, boolean)
instead, which provides the same functionality but allows you to indicate
whether or not to record the result in statistics as a reject.The Redirect behaviour applied is as follows:
iddPrefix
- the IDD prefix used by the Redirect logic to convert addresses to
national format.countryCode
- the country code used by the Redirect logic to convert addresses
to national format.redirectPrefix
- the redirect prefix added by the Redirect logic.abortDialog
- if true
the network dialog will be terminated
with a User Abort after the response has been sent. If false
the dialog will be terminated with a Close using a basic end.NullPointerException
- if any argument is null
.IllegalStateException
- if the service has already returned a response
to the SIS for this event. This exception may also be thrown if
the service takes too long to respond to the request and a timeout
has occurred in the SIS.