4.1.0.610 20071213

ch.ecma.csta.binding
Class NetworkReachedEvent

java.lang.Object
  extended by ch.ecma.csta.CastorObject
      extended by ch.ecma.csta.binding.NetworkReachedEvent
All Implemented Interfaces:
java.io.Serializable

public class NetworkReachedEvent
extends ch.ecma.csta.CastorObject
implements java.io.Serializable

Not implemented.

Indicates that a call has been connected to an external network using a Network Interface Device (for example, trunk, CO Line). This event indicates that there may be a reduced level of event reporting and possibly no additional device feedback, except connection/call clearing, provided for this device in the call due to a lack of network signalling. The level of signalling provided by the network may be indicated by the networkCapability parameter.

Additionally, the computing function should assume that it cannot directly manipulate the far-end device associated with the Network Interface Device.

This event is never sent for calls made to devices that are within the switching sub-domain. This event indicates that a connection with a Network Interface Device has reached the connected state, and that further events for that connection refer to the state of the endpoint which the Network Interface Device is associated.

For an illustration of this event, see ECMA 269, section 17.2.12, Figure 17-44 "Network Reached Event".

A common situation that generates this event includes: An outgoing call has cut-through at a network interface device and further call progress information, such as the DeliveredEvent and the EstablishedEvent, may not be available.

A more complete list of causes is found in ECMA 269, section 17.2.12.2, Table 17.167 "Network Reached - Event Causes".

CSTA Functional Requirements:

  1. When observing a call or a device in a call, and the call diverts from a device in the call, if the switching function does not provide the DivertedEvent for all devices in a call or for call-type monitors (as indicated through the capabilities exchange services option), the computing function will use the networkInterfaceUsed, calledDevice, lastRedirectionDevice, and cause (EventCause parameter type) parameters to properly track the progress of the call as a result of the redirection. See Tracking a Diverted Call for more information.
  2. After a call has cut through the switching sub-domain boundary to another network (Network Reached event generated), all subsequent events reported for the endpoint to which the Network Interface Device (for example, trunk, CO Line) is associated will include a cause parameter with a cause of Network Signal or a more specific cause representing network information.
  3. For external incoming calls, the contents of the networkCallingDeviceID and the networkCalledDeviceID parameters will not change as long as the associatedCallingDevice remains in the call. This differs from the callingDeviceID and the calledDeviceID parameters in that these parameters may change as a result of features such as transfer, forwarding, and conferencing, etc.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
NetworkReachedEvent()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Note: hashCode() has not been overriden
 AssociatedCallingDeviceID getAssociatedCallingDevice()
          Returns the value of field 'associatedCallingDevice'.
 CallCharacteristics getCallCharacteristics()
          Returns the value of field 'callCharacteristics'.
 CalledDeviceID getCalledDevice()
          Returns the value of field 'calledDevice'.
 CallingDeviceID getCallingDevice()
          Returns the value of field 'callingDevice'.
 CallLinkageData getCallLinkageData()
          Returns the value of field 'callLinkageData'.
 EventCause getCause()
          Returns the value of field 'cause'.
 CorrelatorData getCorrelatorData()
          Returns the value of field 'correlatorData'.
 CSTACommonArguments getExtensions()
          Returns the value of field 'extensions'.
 java.lang.String getLanguagePreferences()
          Returns the value of field 'languagePreferences'.
 RedirectionDeviceID getLastRedirectionDevice()
          Returns the value of field 'lastRedirectionDevice'.
 LocalConnectionState getLocalConnectionInfo()
          Returns the value of field 'localConnectionInfo'.
 MediaCallCharacteristics getMediaCallCharacteristics()
          Returns the value of field 'mediaCallCharacteristics'.
 java.lang.String getMonitorCrossRefID()
          Returns the value of field 'monitorCrossRefID'.
 NetworkCalledDeviceID getNetworkCalledDevice()
          Returns the value of field 'networkCalledDevice'.
 NetworkCallingDeviceID getNetworkCallingDevice()
          Returns the value of field 'networkCallingDevice'.
 NetworkCapability getNetworkCapability()
          Returns the value of field 'networkCapability'.
 SubjectDeviceID getNetworkInterfaceUsed()
          Returns the value of field 'networkInterfaceUsed'.
 ConnectionID getOriginatingNIDConnection()
          Returns the value of field 'originatingNIDConnection'.
 ConnectionID getOutboundConnection()
          Returns the value of field 'outboundConnection'.
 ConnectionInformation getOutboundConnectionInfo()
          Returns the value of field 'outboundConnectionInfo'.
 ServicesPermitted getServicesPermitted()
          Returns the value of field 'servicesPermitted'.
 UserData getUserData()
          Returns the value of field 'userData'.
 boolean isValid()
          Method isValid
 void marshal(org.xml.sax.ContentHandler handler)
          Method marshal
 void marshal(java.io.Writer out)
          Method marshal
 void setAssociatedCallingDevice(AssociatedCallingDeviceID associatedCallingDevice)
          Sets the value of field 'associatedCallingDevice'.
 void setCallCharacteristics(CallCharacteristics callCharacteristics)
          Sets the value of field 'callCharacteristics'.
 void setCalledDevice(CalledDeviceID calledDevice)
          Sets the value of field 'calledDevice'.
 void setCallingDevice(CallingDeviceID callingDevice)
          Sets the value of field 'callingDevice'.
 void setCallLinkageData(CallLinkageData callLinkageData)
          Sets the value of field 'callLinkageData'.
 void setCause(EventCause cause)
          Sets the value of field 'cause'.
 void setCorrelatorData(CorrelatorData correlatorData)
          Sets the value of field 'correlatorData'.
 void setExtensions(CSTACommonArguments extensions)
          Sets the value of field 'extensions'.
 void setLanguagePreferences(java.lang.String languagePreferences)
          Sets the value of field 'languagePreferences'.
 void setLastRedirectionDevice(RedirectionDeviceID lastRedirectionDevice)
          Sets the value of field 'lastRedirectionDevice'.
 void setLocalConnectionInfo(LocalConnectionState localConnectionInfo)
          Sets the value of field 'localConnectionInfo'.
 void setMediaCallCharacteristics(MediaCallCharacteristics mediaCallCharacteristics)
          Sets the value of field 'mediaCallCharacteristics'.
 void setMonitorCrossRefID(java.lang.String monitorCrossRefID)
          Sets the value of field 'monitorCrossRefID'.
 void setNetworkCalledDevice(NetworkCalledDeviceID networkCalledDevice)
          Sets the value of field 'networkCalledDevice'.
 void setNetworkCallingDevice(NetworkCallingDeviceID networkCallingDevice)
          Sets the value of field 'networkCallingDevice'.
 void setNetworkCapability(NetworkCapability networkCapability)
          Sets the value of field 'networkCapability'.
 void setNetworkInterfaceUsed(SubjectDeviceID networkInterfaceUsed)
          Sets the value of field 'networkInterfaceUsed'.
 void setOriginatingNIDConnection(ConnectionID originatingNIDConnection)
          Sets the value of field 'originatingNIDConnection'.
 void setOutboundConnection(ConnectionID outboundConnection)
          Sets the value of field 'outboundConnection'.
 void setOutboundConnectionInfo(ConnectionInformation outboundConnectionInfo)
          Sets the value of field 'outboundConnectionInfo'.
 void setServicesPermitted(ServicesPermitted servicesPermitted)
          Sets the value of field 'servicesPermitted'.
 void setUserData(UserData userData)
          Sets the value of field 'userData'.
static NetworkReachedEvent unmarshalNetworkReachedEvent(java.io.Reader reader)
          Method unmarshalNetworkReachedEvent
 void validate()
          Method validate
 
Methods inherited from class ch.ecma.csta.CastorObject
getOldSessionID, hashCode, setOldSessionID, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NetworkReachedEvent

public NetworkReachedEvent()
Method Detail

equals

public boolean equals(java.lang.Object obj)
Note: hashCode() has not been overriden

Overrides:
equals in class ch.ecma.csta.CastorObject
Parameters:
obj -
Returns:
boolean

getAssociatedCallingDevice

public AssociatedCallingDeviceID getAssociatedCallingDevice()
Returns the value of field 'associatedCallingDevice'.

Returns:
AssociatedCallingDeviceID

getCallCharacteristics

public CallCharacteristics getCallCharacteristics()
Returns the value of field 'callCharacteristics'.

Returns:
CallCharacteristics

getCallLinkageData

public CallLinkageData getCallLinkageData()
Returns the value of field 'callLinkageData'.

Returns:
CallLinkageData

getCalledDevice

public CalledDeviceID getCalledDevice()
Returns the value of field 'calledDevice'.

Returns:
CalledDeviceID

getCallingDevice

public CallingDeviceID getCallingDevice()
Returns the value of field 'callingDevice'.

Returns:
CallingDeviceID

getCause

public EventCause getCause()
Returns the value of field 'cause'.

Returns:
EventCause

getCorrelatorData

public CorrelatorData getCorrelatorData()
Returns the value of field 'correlatorData'.

Returns:
CorrelatorData

getExtensions

public CSTACommonArguments getExtensions()
Returns the value of field 'extensions'.

Returns:
CSTACommonArguments

getLanguagePreferences

public java.lang.String getLanguagePreferences()
Returns the value of field 'languagePreferences'.

Returns:
String

getLastRedirectionDevice

public RedirectionDeviceID getLastRedirectionDevice()
Returns the value of field 'lastRedirectionDevice'.

Returns:
RedirectionDeviceID

getLocalConnectionInfo

public LocalConnectionState getLocalConnectionInfo()
Returns the value of field 'localConnectionInfo'.

Returns:
LocalConnectionState

getMediaCallCharacteristics

public MediaCallCharacteristics getMediaCallCharacteristics()
Returns the value of field 'mediaCallCharacteristics'.

Returns:
MediaCallCharacteristics

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()
Returns the value of field 'monitorCrossRefID'.

Returns:
String

getNetworkCalledDevice

public NetworkCalledDeviceID getNetworkCalledDevice()
Returns the value of field 'networkCalledDevice'.

Returns:
NetworkCalledDeviceID

getNetworkCallingDevice

public NetworkCallingDeviceID getNetworkCallingDevice()
Returns the value of field 'networkCallingDevice'.

Returns:
NetworkCallingDeviceID

getNetworkCapability

public NetworkCapability getNetworkCapability()
Returns the value of field 'networkCapability'. The field 'networkCapability' has the following description: Specifies the type of network reached and the Call Control events supported by the network.

It includes the following components:

  1. networkType (M) - The complete set of possible values is:
    • ISDN public
    • Non-ISDN public
    • ISDN private
    • Non-ISDN private
    • Other
  2. eventsProvided (O) - This is a bitmap of the Call Control events defined in this Standard.

Returns:
NetworkCapability

getNetworkInterfaceUsed

public SubjectDeviceID getNetworkInterfaceUsed()
Returns the value of field 'networkInterfaceUsed'. The field 'networkInterfaceUsed' has the following description: Specifies the Network Interface Device that was selected. Mandatory.

Returns:
SubjectDeviceID

getOriginatingNIDConnection

public ConnectionID getOriginatingNIDConnection()
Returns the value of field 'originatingNIDConnection'.

Returns:
ConnectionID

getOutboundConnection

public ConnectionID getOutboundConnection()
Returns the value of field 'outboundConnection'. The field 'outboundConnection' has the following description: Specifies the outbound connection associated with the call that is leaving the switching sub-domain. Mandatory.

Returns:
ConnectionID

getOutboundConnectionInfo

public ConnectionInformation getOutboundConnectionInfo()
Returns the value of field 'outboundConnectionInfo'. The field 'outboundConnectionInfo' has the following description: Specifies the connection information associated with the outboundConnection connection. Optional. If this parameter is not present, then the connection information is switching function specific.

Returns:
ConnectionInformation

getServicesPermitted

public ServicesPermitted getServicesPermitted()
Returns the value of field 'servicesPermitted'.

Returns:
ServicesPermitted

getUserData

public UserData getUserData()
Returns the value of field 'userData'.

Returns:
UserData

isValid

public boolean isValid()
Method isValid

Returns:
boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Method marshal

Parameters:
out -
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Method marshal

Parameters:
handler -
Throws:
java.io.IOException
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

setAssociatedCallingDevice

public void setAssociatedCallingDevice(AssociatedCallingDeviceID associatedCallingDevice)
Sets the value of field 'associatedCallingDevice'.

Parameters:
associatedCallingDevice - the value of field 'associatedCallingDevice'.

setCallCharacteristics

public void setCallCharacteristics(CallCharacteristics callCharacteristics)
Sets the value of field 'callCharacteristics'.

Parameters:
callCharacteristics - the value of field 'callCharacteristics'.

setCallLinkageData

public void setCallLinkageData(CallLinkageData callLinkageData)
Sets the value of field 'callLinkageData'.

Parameters:
callLinkageData - the value of field 'callLinkageData'.

setCalledDevice

public void setCalledDevice(CalledDeviceID calledDevice)
Sets the value of field 'calledDevice'.

Parameters:
calledDevice - the value of field 'calledDevice'.

setCallingDevice

public void setCallingDevice(CallingDeviceID callingDevice)
Sets the value of field 'callingDevice'.

Parameters:
callingDevice - the value of field 'callingDevice'.

setCause

public void setCause(EventCause cause)
Sets the value of field 'cause'.

Parameters:
cause - the value of field 'cause'.

setCorrelatorData

public void setCorrelatorData(CorrelatorData correlatorData)
Sets the value of field 'correlatorData'.

Parameters:
correlatorData - the value of field 'correlatorData'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)
Sets the value of field 'extensions'.

Parameters:
extensions - the value of field 'extensions'.

setLanguagePreferences

public void setLanguagePreferences(java.lang.String languagePreferences)
Sets the value of field 'languagePreferences'.

Parameters:
languagePreferences - the value of field 'languagePreferences'.

setLastRedirectionDevice

public void setLastRedirectionDevice(RedirectionDeviceID lastRedirectionDevice)
Sets the value of field 'lastRedirectionDevice'.

Parameters:
lastRedirectionDevice - the value of field 'lastRedirectionDevice'.

setLocalConnectionInfo

public void setLocalConnectionInfo(LocalConnectionState localConnectionInfo)
Sets the value of field 'localConnectionInfo'.

Parameters:
localConnectionInfo - the value of field 'localConnectionInfo'.

setMediaCallCharacteristics

public void setMediaCallCharacteristics(MediaCallCharacteristics mediaCallCharacteristics)
Sets the value of field 'mediaCallCharacteristics'.

Parameters:
mediaCallCharacteristics - the value of field 'mediaCallCharacteristics'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)
Sets the value of field 'monitorCrossRefID'.

Parameters:
monitorCrossRefID - the value of field 'monitorCrossRefID'.

setNetworkCalledDevice

public void setNetworkCalledDevice(NetworkCalledDeviceID networkCalledDevice)
Sets the value of field 'networkCalledDevice'.

Parameters:
networkCalledDevice - the value of field 'networkCalledDevice'.

setNetworkCallingDevice

public void setNetworkCallingDevice(NetworkCallingDeviceID networkCallingDevice)
Sets the value of field 'networkCallingDevice'.

Parameters:
networkCallingDevice - the value of field 'networkCallingDevice'.

setNetworkCapability

public void setNetworkCapability(NetworkCapability networkCapability)
Sets the value of field 'networkCapability'. The field 'networkCapability' has the following description: Specifies the type of network reached and the Call Control events supported by the network.

It includes the following components:

  1. networkType (M) - The complete set of possible values is:
    • ISDN public
    • Non-ISDN public
    • ISDN private
    • Non-ISDN private
    • Other
  2. eventsProvided (O) - This is a bitmap of the Call Control events defined in this Standard.

Parameters:
networkCapability - the value of field 'networkCapability'.

setNetworkInterfaceUsed

public void setNetworkInterfaceUsed(SubjectDeviceID networkInterfaceUsed)
Sets the value of field 'networkInterfaceUsed'. The field 'networkInterfaceUsed' has the following description: Specifies the Network Interface Device that was selected. Mandatory.

Parameters:
networkInterfaceUsed - the value of field 'networkInterfaceUsed'.

setOriginatingNIDConnection

public void setOriginatingNIDConnection(ConnectionID originatingNIDConnection)
Sets the value of field 'originatingNIDConnection'.

Parameters:
originatingNIDConnection - the value of field 'originatingNIDConnection'.

setOutboundConnection

public void setOutboundConnection(ConnectionID outboundConnection)
Sets the value of field 'outboundConnection'. The field 'outboundConnection' has the following description: Specifies the outbound connection associated with the call that is leaving the switching sub-domain. Mandatory.

Parameters:
outboundConnection - the value of field 'outboundConnection'.

setOutboundConnectionInfo

public void setOutboundConnectionInfo(ConnectionInformation outboundConnectionInfo)
Sets the value of field 'outboundConnectionInfo'. The field 'outboundConnectionInfo' has the following description: Specifies the connection information associated with the outboundConnection connection. Optional. If this parameter is not present, then the connection information is switching function specific.

Parameters:
outboundConnectionInfo - the value of field 'outboundConnectionInfo'.

setServicesPermitted

public void setServicesPermitted(ServicesPermitted servicesPermitted)
Sets the value of field 'servicesPermitted'.

Parameters:
servicesPermitted - the value of field 'servicesPermitted'.

setUserData

public void setUserData(UserData userData)
Sets the value of field 'userData'.

Parameters:
userData - the value of field 'userData'.

unmarshalNetworkReachedEvent

public static NetworkReachedEvent unmarshalNetworkReachedEvent(java.io.Reader reader)
                                                        throws org.exolab.castor.xml.MarshalException,
                                                               org.exolab.castor.xml.ValidationException
Method unmarshalNetworkReachedEvent

Parameters:
reader -
Returns:
NetworkReachedEvent
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Method validate

Throws:
org.exolab.castor.xml.ValidationException

4.1.0.610 20071213

Copyright 2004 Avaya Inc All Rights Reserved.