hp.opencall.media.ccapi
Interface ISDNCallSpecInterface

All Superinterfaces:

CallSpecInterface

All Known Implementing Classes:

ISDNCallSpec

public interface ISDNCallSpecInterface

extends CallSpecInterface

Stores information needed to place the call.

Method Summary

void	addISDNRedirectElement(ISDNRedirectElement anElement) Add an ISDN call redirection path.
void	freeIsupInfoMsg() Deprecated. IsupMsg memory is handled by the JVM
byte[]	getCalledPartyNumberBytes() Gets CalledPartyNumberBytes.
byte[]	getCallReference() Gets the Call Reference.
int	getCIC() Gets the Circuit Identifier Code (CIC).
long	getDPC() Gets the Destination Point Code (DPC).
int	getIIDigits() Gets the II Digits.
ISDNSignallingParty	getISDNCalledParty() ISDN Called party accessor (DNIS)
ISDNSignallingParty	getISDNCallingParty() ISDN Calling party accessor (ANI)OR null if the calling address is not specified in the call associated to this CallSpec
ISDNRedirectElement[]	getISDNRedirectElements() Gives access to the redirection paths.
IsupInfo	getIsupInfo() Gets the IsupInfo.
E164Address	getOriginalCalledNumber() Gets the Original Called Number.
Q850Cause	getQ850Cause() Get the last received Q850 cause
boolean	isCalledPartyNumberBytesPresent() Checks if CalledPartyNumberBytes is known.
boolean	isCallReferencePresent() Checks if the Call Reference is known.
boolean	isCICPresent() Sets the ISDN handler - Reserved for internal use.
boolean	isDPCPresent() Checks if the Destination Point Code is known.
boolean	isIIDigitsPresent() Checks if the II Digits are knowns.
boolean	isIsupInfoPresent() Checks if IsupInfo is available.
boolean	isOriginalCalledNumberPresent() Checks if the Original Called Number is known.
void	setCalledPartyNumberBytes(byte[] calledPartyNumberBytes) Sets CalledPartyNumberBytes.
void	setCallReference(byte[] aCallReference) Sets the Call Reference.
void	setDPC(long adpc) Sets the Destination Point Code (DPC) for an outgoing call.
void	setIIDigits(int aIIDigits) Sets the II Digits.
void	setIsupInfo(IsupInfo aIsupInfo) Sets the IsupInfo.
void	setOriginalCalledNumber(E164Address aOriginalCalledNumber) Sets the Original Called Number
void	setQ850Cause(Q850Cause aCause) Set the Q850 to use for the next ISDN message

Methods inherited from interface hp.opencall.media.ccapi.CallSpecInterface

addRedirectElement, getCalledAddress, getCalledParty, getCallingAddress, getCallingParty, getCallSpecType, getProtocolName, getProtocolVersion, getRedirectElements, isIncoming, setUsedProvider

Method Detail

isCICPresent

public boolean isCICPresent()

Sets the ISDN handler - Reserved for internal use.

Returns:

boolean

getCIC

public int getCIC()

Gets the Circuit Identifier Code (CIC).

Returns:

the Circuit Identfier Code (CIC) if the isCICPresent() method has returned true.

isDPCPresent

public boolean isDPCPresent()

Checks if the Destination Point Code is known.

Returns:

true if the Destination Point Code (DPC) is known.

getDPC

public long getDPC()

Gets the Destination Point Code (DPC).

Returns:

the Destination Point Code (DPC) if the isDPCPresent() method has returned true.

setDPC

public void setDPC(long adpc)

Sets the Destination Point Code (DPC) for an outgoing call. Its use allows the oclet to specify the DPC - this is necessary for Local Number Portability (LNP), which cannot route a call to the proper DPC based on the called number.

Parameters:

adpc -

isIIDigitsPresent

public boolean isIIDigitsPresent()

Checks if the II Digits are knowns.

Returns:

true if the II Digits are knowns.

getIIDigits

public int getIIDigits()

Gets the II Digits.

Returns:

the II Digits if the isIIDigitsPresent() method has returned true.

setIIDigits

public void setIIDigits(int aIIDigits)

Sets the II Digits.

Parameters:

aIIDigits - the II Digits.

isOriginalCalledNumberPresent

public boolean isOriginalCalledNumberPresent()

Checks if the Original Called Number is known. Information sent in the forward direction when a call is redirected and identifies the original called party.

Returns:

true if the Original Called Number is known.

getOriginalCalledNumber

public E164Address getOriginalCalledNumber()

Gets the Original Called Number.

Returns:

the Original Called Number if the isOriginalCalledNumberPresent() method has returned true.

setOriginalCalledNumber

public void setOriginalCalledNumber(E164Address aOriginalCalledNumber)

Sets the Original Called Number

Parameters:

aOriginalCalledNumber - the Original Called Number to indicate that the call is redirected.

isCallReferencePresent

public boolean isCallReferencePresent()

Checks if the Call Reference is known.

Returns:

true if the Call Reference is known.

getCallReference

public byte[] getCallReference()

Gets the Call Reference.

Returns:

the Call Reference if the isCallReferencePresent() method has returned true.

setCallReference

public void setCallReference(byte[] aCallReference)

Sets the Call Reference.

Parameters:

aCallReference - the Call Reference.

isIsupInfoPresent

public boolean isIsupInfoPresent()

Checks if IsupInfo is available.

Returns:

true if IsupInfo is available.

Since:

OCMP 2.3

freeIsupInfoMsg

public void freeIsupInfoMsg()

Deprecated. IsupMsg memory is handled by the JVM

free the Incoming Msg IsupInfo.

isCalledPartyNumberBytesPresent

public boolean isCalledPartyNumberBytesPresent()

Checks if CalledPartyNumberBytes is known.

Returns:

true if CalledPartyNumberBytes is known, false otherwise.

getCalledPartyNumberBytes

public byte[] getCalledPartyNumberBytes()

Gets CalledPartyNumberBytes.

Returns:

CalledPartyNumberBytes if isCalledPartyNumberBytesPresent() method returned true.

setCalledPartyNumberBytes

public void setCalledPartyNumberBytes(byte[] calledPartyNumberBytes)

Sets CalledPartyNumberBytes.

Parameters:

calledPartyNumberBytes - the CalledPartyNumberBytes.

getIsupInfo

public IsupInfo getIsupInfo()

Gets the IsupInfo.

Returns:

the IsupInfo

Since:

OCMP 2.3

setIsupInfo

public void setIsupInfo(IsupInfo aIsupInfo)

Sets the IsupInfo.

Parameters:

aIsupInfo - the IsupInfo

Since:

OCMP 2.3

getISDNCalledParty

public ISDNSignallingParty getISDNCalledParty()

ISDN Called party accessor (DNIS)

Returns:

hp.opencall.media.ccapi.ISDNSignallingParty

getISDNRedirectElements

public ISDNRedirectElement[] getISDNRedirectElements()

Gives access to the redirection paths. FromVXML: This variable is an array representing the connection redirection paths. The first element is the original called number, the last element is the last redirected number.

Returns:

hp.opencall.media.ccapi.ISDNRedirectElement[]

addISDNRedirectElement

public void addISDNRedirectElement(ISDNRedirectElement anElement)

Add an ISDN call redirection path. The first element is the original called number, the last element is the last redirected number.

Parameters:

anElement -

getISDNCallingParty

public ISDNSignallingParty getISDNCallingParty()

ISDN Calling party accessor (ANI)OR null if the calling address is not specified in the call associated to this CallSpec

Returns:

hp.opencall.media.ccapi.ISDNSignallingParty

getQ850Cause

public Q850Cause getQ850Cause()

Get the last received Q850 cause

Returns:

Q850Cause

setQ850Cause

public void setQ850Cause(Q850Cause aCause)

Set the Q850 to use for the next ISDN message

Parameters:

aCause -