hp.opencall.media.ccapi
Class CallSpec

java.lang.Object
  hp.opencall.media.platform.connection.InternalCallSpec
      hp.opencall.media.ccapi.CallSpec

All Implemented Interfaces:

CallSpecInterface

Direct Known Subclasses:

ISDNCallSpec, SIPCallSpec

public class CallSpec

extends hp.opencall.media.platform.connection.InternalCallSpec

implements CallSpecInterface

A CallSpec stores the addresses, i.e. the calling (ANI) and the called address of a Call (DNIS). ANI (Automatic Number Identification) tells you the number your caller dialed from. DNIS (Dialed Number Identification Service) tells you the number the caller dialed.

Since:

OCMP 2.0

Nested Class Summary

class

CallSpec.CallSpecType Call origin The CallSpecType class supplies the different CallSpec type value

Field Summary

Fields inherited from class hp.opencall.media.platform.connection.InternalCallSpec

defaultConnectionType

Constructor Summary

CallSpec(Address to)
Deprecated. use the contructor with Signalling party instead

CallSpec(Address to, Address from)
Deprecated. use CallSpec(SignallingParty to, SignallingParty from) instead

CallSpec(SignallingParty to)
Creates a CallSpec with the specified called party (DNIS)

CallSpec(SignallingParty to, SignallingParty from)
Creates a CallSpec with the specified called (DNIS) and calling (ANI) parties.

Method Summary

void	addRedirectElement(RedirectElement anElement) Add call redirection path.
Address	getCalledAddress() Deprecated. use getCalledParty() instead
SignallingParty	getCalledParty() Called party Accessor
Address	getCallingAddress() Deprecated. use getCallingParty() instead
SignallingParty	getCallingParty() Calling Party Accessor OR null if the calling address is not specified in the call associated to this CallSpec
int	getCallSpecType() Returns the CallSpec Type
String	getOwnerServiceName() Returns the Name of the service which owns the TrunkLeg described by this CallSpec
String	getProtocolName() return the procole name.
String	getProtocolVersion() return the procole version.
RedirectElement[]	getRedirectElements() give access to the redirection history.
String	getRoutingInfo() Get the routing information for outgoing call
boolean	isIncoming() Returns the side from which call was originated
void	setRoutingInfo(String value) Set in callSpec the routing information for outgoing call
void	setUsedProvider(hp.opencall.media.signalling.CnxProviderIF aCnxProviderIF) Set in callSpec the Connection provider used
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CallSpec

public CallSpec(SignallingParty to,
                SignallingParty from)

Creates a CallSpec with the specified called (DNIS) and calling (ANI) parties.

Parameters:

to - called party (DNIS)

from - calling party (ANI)

CallSpec

public CallSpec(SignallingParty to)

Creates a CallSpec with the specified called party (DNIS)

Parameters:

to - called party (DNIS)

CallSpec

public CallSpec(Address to,
                Address from)

Deprecated. use CallSpec(SignallingParty to, SignallingParty from) instead

Creates a CallSpec with the specified called (DNIS) and calling (ANI) addresses.

Parameters:

to -

from -

CallSpec

public CallSpec(Address to)

Deprecated. use the contructor with Signalling party instead

Creates a CallSpec with the specified called address (DNIS).

Parameters:

to -

Method Detail

isIncoming

public boolean isIncoming()

Returns the side from which call was originated

Specified by:

isIncoming in interface CallSpecInterface

Returns:

true if incoming call, false otherwise

getCalledAddress

public Address getCalledAddress()

Deprecated. use getCalledParty() instead

Returns the called address (DNIS) of the CallSpec.

Specified by:

getCalledAddress in interface CallSpecInterface

Returns:

the called address (DNIS) of the CallSpec.

getCallingAddress

public Address getCallingAddress()

Deprecated. use getCallingParty() instead

Returns the calling address (ANI) of the CallSpec.

Specified by:

getCallingAddress in interface CallSpecInterface

Returns:

the calling address (ANI) of the CallSpec OR null if the calling address is not specified in the call associated to this CallSpec.

getCallSpecType

public int getCallSpecType()

Returns the CallSpec Type

Specified by:

getCallSpecType in interface CallSpecInterface

Returns:

a CallSpec type value according to the CallSpecType class

setUsedProvider

public void setUsedProvider(hp.opencall.media.signalling.CnxProviderIF aCnxProviderIF)

Set in callSpec the Connection provider used

Specified by:

setUsedProvider in interface CallSpecInterface

Parameters:

aCnxProviderIF - specifies the Connection provider used

getCalledParty

public SignallingParty getCalledParty()

Called party Accessor

Specified by:

getCalledParty in interface CallSpecInterface

Returns:

hp.opencall.media.ccapi.SignallingParty

getRedirectElements

public RedirectElement[] getRedirectElements()

give access to the redirection history. 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. should be empty if not set yet

Specified by:

getRedirectElements in interface CallSpecInterface

Returns:

hp.opencall.media.ccapi.RedirectElement[]

getCallingParty

public SignallingParty getCallingParty()

Calling Party Accessor OR null if the calling address is not specified in the call associated to this CallSpec

Specified by:

getCallingParty in interface CallSpecInterface

Returns:

hp.opencall.media.ccapi.SignallingParty

addRedirectElement

public void addRedirectElement(RedirectElement anElement)

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

Specified by:

addRedirectElement in interface CallSpecInterface

Parameters:

anElement -

getOwnerServiceName

public String getOwnerServiceName()

Returns the Name of the service which owns the TrunkLeg described by this CallSpec

Returns:

a String representing the service name

toString

public String toString()

getProtocolName

public String getProtocolName()

Description copied from interface: CallSpecInterface

return the procole name.

Specified by:

getProtocolName in interface CallSpecInterface

getProtocolVersion

public String getProtocolVersion()

Description copied from interface: CallSpecInterface

return the procole version.

Specified by:

getProtocolVersion in interface CallSpecInterface

setRoutingInfo

public void setRoutingInfo(String value)

Set in callSpec the routing information for outgoing call

Parameters:

value - of the routing information

getRoutingInfo

public String getRoutingInfo()

Get the routing information for outgoing call

Returns:

java.lang.String