org.mobicents.protocols.ss7.map.api
Interface MAPDialog

public interface MAPDialog

Author:

amit bhayani

Method Summary

void	abort(MAPUserAbortChoice mapUserAbortChoice) This is equivalent to MAP User issuing the MAP_U_ABORT Service Request.
void	addProcessUnstructuredSSRequest(byte ussdDataCodingScheme, USSDString ussdString, AddressString msisdn) Add's a new Process Unstructured SS Request as Component.
void	addProcessUnstructuredSSResponse(long invokeId, boolean lastResult, byte ussdDataCodingScheme, USSDString ussdString) Add's a new ProcessUnstructured SS Response as Component.
void	addUnstructuredSSRequest(byte ussdDataCodingScheme, USSDString ussdString) Add's a new Unstructured SS Request
void	addUnstructuredSSResponse(long invokeId, boolean lastResult, byte ussdDataCodingScheme, USSDString ussdString) Add's a new Unstructured SS Response
void	close(boolean prearrangedEnd) This is equivalent of MAP User issuing the MAP_CLOSE Service Request.
java.lang.Long	getDialogId() Returns this Dialog's ID.
void	send() This is equivalent of MAP User issuing the MAP_DELIMITER Service Request.

Method Detail

getDialogId

java.lang.Long getDialogId()

Returns this Dialog's ID. This ID is actually TCAP's Dialog ID. org.mobicents.protocols.ss7.tcap.api.tc.dialog.Dialog

Returns:

send

void send()
          throws MAPException

This is equivalent of MAP User issuing the MAP_DELIMITER Service Request. send() is called to explicitly request the transfer of the MAP protocol data units to the peer entities.

Throws:

MAPException

close

void close(boolean prearrangedEnd)
           throws MAPException

This is equivalent of MAP User issuing the MAP_CLOSE Service Request. This service is used for releasing a previously established MAP dialogue. The service may be invoked by either MAP service-user depending on rules defined within the service-user.
If prearrangedEnd is false, all the Service Primitive added to MAPDialog and not sent yet, will be sent to peer.
If prearrangedEnd is true, all the Service Primitive added to MAPDialog and not sent yet, will not be sent to peer.

Parameters:

prearrangedEnd -

Throws:

MAPException

abort

void abort(MAPUserAbortChoice mapUserAbortChoice)
           throws MAPException

This is equivalent to MAP User issuing the MAP_U_ABORT Service Request.

Parameters:

userReason -

Throws:

MAPException

addProcessUnstructuredSSRequest

void addProcessUnstructuredSSRequest(byte ussdDataCodingScheme,
                                     USSDString ussdString,
                                     AddressString msisdn)
                                     throws MAPException

Add's a new Process Unstructured SS Request as Component.

Parameters:

ussdDataCodingScheme - The Data Coding Scheme for this USSD String as defined in GSM 03.38

ussdString - Ussd String

msisdn - The MSISDN in AddressString format. This is optional

Throws:

MAPException

addProcessUnstructuredSSResponse

void addProcessUnstructuredSSResponse(long invokeId,
                                      boolean lastResult,
                                      byte ussdDataCodingScheme,
                                      USSDString ussdString)
                                      throws MAPException

Add's a new ProcessUnstructured SS Response as Component.

Parameters:

invokeId - The original invoke ID retrieved from ProcessUnstructuredSSIndication

lastResult - Specify if this Result is last - true, or there would be follow-up results - false

ussdDataCodingScheme - The Data Coding Scheme for this USSD String as defined in GSM 03.38

ussdString - Ussd String USSDString

Throws:

MAPException

addUnstructuredSSRequest

void addUnstructuredSSRequest(byte ussdDataCodingScheme,
                              USSDString ussdString)
                              throws MAPException

Add's a new Unstructured SS Request

Parameters:

ussdDataCodingScheme - The Data Coding Scheme for this USSD String as defined in GSM 03.38

ussdString - Ussd String USSDString

Throws:

MAPException

addUnstructuredSSResponse

void addUnstructuredSSResponse(long invokeId,
                               boolean lastResult,
                               byte ussdDataCodingScheme,
                               USSDString ussdString)
                               throws MAPException

Add's a new Unstructured SS Response

Parameters:

invokeId - The original invoke ID retrieved from UnstructuredSSIndication

lastResult - Specify if this Result is last - true, or there would be follow-up results - false

ussdDataCodingScheme - The Data Coding Scheme for this USSD String as defined in GSM 03.38

ussdString - Ussd String USSDString

Throws:

MAPException