Package com.opencloud.sentinel.ipsmgw.eventmanager.tcapmessage

Interface DialogTcapMessage

All Known Implementing Classes:

BaseDialogTcapMessage, DialogMessageTcapMessage, DialogOpenRefuseTcapMessage, DialogOpenRequestTcapMessage, DialogProviderAbortTcapMessage, DialogUserAbortTcapMessage

public interface DialogTcapMessage

Common interface to tcap messages received in a dialog

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DialogTcapMessage.Type	The types of dialog tcap message

Method Summary

Modifier and Type	Method	Description
DialogMessageTcapMessage	asDialogMessage()
DialogMessageTcapMessage	asDialogOpenAccept()
DialogOpenRefuseTcapMessage	asDialogOpenRefuse()
DialogOpenRequestTcapMessage	asDialogOpenRequest()
DialogProviderAbortTcapMessage	asDialogProviderAbort()
DialogUserAbortTcapMessage	asDialogUserAbort()
void	asTcContinue()	change this message to be a TC-Continue, if possible.
void	asTcEnd()	change this message to be a TC-End(prearranged = false), if possible.
void	asTcEnd(boolean prearranged)	change this message to be a TC-End(prearranged), if possible.
TcapComponent[]	getComponents()
DialogTcapMessage.Type	getType()
boolean	hasComponents()
boolean	isPrearrangedEnd()
boolean	isTcBegin()
boolean	isTcContinue()
boolean	isTcEnd()
boolean	isType(DialogTcapMessage.Type toCheck)

Method Detail

getType

DialogTcapMessage.Type getType()

Returns:

the type of this tcap dialog message

isType

boolean isType(DialogTcapMessage.Type toCheck)

Parameters:

toCheck - the type to compare the type of this tcap message to

Returns:

true, if the type if this tcap message is the compatible toCheck

isTcBegin

boolean isTcBegin()

Returns:

true is this message is a TC-Begin

isTcContinue

boolean isTcContinue()

Returns:

true is this message is a TC-Continue

isTcEnd

boolean isTcEnd()

Returns:

true is this message is a TC-End

isPrearrangedEnd

boolean isPrearrangedEnd()

Returns:

true if the prearranged flag is true

asTcContinue

void asTcContinue()

change this message to be a TC-Continue, if possible.

asTcEnd

void asTcEnd()

change this message to be a TC-End(prearranged = false), if possible.

asTcEnd

void asTcEnd(boolean prearranged)

change this message to be a TC-End(prearranged), if possible.

hasComponents

boolean hasComponents()

Returns:

true if this message has some associated components

getComponents

TcapComponent[] getComponents()

Returns:

the components associated with this message

asDialogOpenRequest

DialogOpenRequestTcapMessage asDialogOpenRequest()

Returns:

this message as an open request

Throws:

java.lang.IllegalArgumentException - if this message is not an open request

asDialogOpenAccept

DialogMessageTcapMessage asDialogOpenAccept()

Returns:

this message as an open accept

Throws:

java.lang.IllegalArgumentException - if this message is not an open accept

asDialogMessage

DialogMessageTcapMessage asDialogMessage()

Returns:

this message as a dialog message

Throws:

java.lang.IllegalArgumentException - if this message is not a dialog message, open accept, or open request

asDialogOpenRefuse

DialogOpenRefuseTcapMessage asDialogOpenRefuse()

Returns:

this message as an open refuse

Throws:

java.lang.IllegalArgumentException - if this message is not an open refuse

asDialogUserAbort

DialogUserAbortTcapMessage asDialogUserAbort()

Returns:

this message as a dialog user abort

Throws:

java.lang.IllegalArgumentException - if this message is not a dialog user abort

asDialogProviderAbort

DialogProviderAbortTcapMessage asDialogProviderAbort()

Returns:

this message as a dialog provider abort

Throws:

java.lang.IllegalArgumentException - if this message is not a dialog provider abort