ch.ecma.csta.binding
Class NetworkCapabilitiesChangedEvent

java.lang.Object
  ch.ecma.csta.CastorObject
      ch.ecma.csta.binding.NetworkCapabilitiesChangedEvent

All Implemented Interfaces:

java.io.Serializable

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

Not implemented.

Indicates that a situation occurred during a call's progress in a public or private network that modifies its signalling capability (that is, inter-networking). It does not indicate a change in the connection state of the Network Interface Device (for example, trunk, CO Line) through which the call has accessed the network.

This event will always be preceded by a NetworkReachedEvent that includes the networkCapability parameter. The event may be repeated according to the situations encountered in the network.

For an illustration of this event, see ECMA 269, section 17.2.11, Figure 17-43 "Network Capabilities Changed Event".

This event is caused by the call encountering an interworking situation.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

NetworkCapabilitiesChangedEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CallCharacteristics	getCallCharacteristics() Returns the value of field 'callCharacteristics'.
CalledDeviceID	getCalledDevice() Returns the value of field 'calledDevice'.
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'.
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'.
NetworkCapability	getNetworkCapability() Returns the value of field 'networkCapability'.
SubjectDeviceID	getNetworkInterfaceUsed() Returns the value of field 'networkInterfaceUsed'.
ConnectionID	getOutboundConnection() Returns the value of field 'outboundConnection'.
ConnectionInformation	getOutboundConnectionInfo() Returns the value of field 'outboundConnectionInfo'.
ProgressIndicator	getProgressIndicator() Returns the value of field 'progressIndicator'.
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	setCallCharacteristics(CallCharacteristics callCharacteristics) Sets the value of field 'callCharacteristics'.
void	setCalledDevice(CalledDeviceID calledDevice) Sets the value of field 'calledDevice'.
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	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	setNetworkCapability(NetworkCapability networkCapability) Sets the value of field 'networkCapability'.
void	setNetworkInterfaceUsed(SubjectDeviceID networkInterfaceUsed) Sets the value of field 'networkInterfaceUsed'.
void	setOutboundConnection(ConnectionID outboundConnection) Sets the value of field 'outboundConnection'.
void	setOutboundConnectionInfo(ConnectionInformation outboundConnectionInfo) Sets the value of field 'outboundConnectionInfo'.
void	setProgressIndicator(ProgressIndicator progressIndicator) Sets the value of field 'progressIndicator'.
void	setServicesPermitted(ServicesPermitted servicesPermitted) Sets the value of field 'servicesPermitted'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static NetworkCapabilitiesChangedEvent	unmarshalNetworkCapabilitiesChangedEvent(java.io.Reader reader) Method unmarshalNetworkCapabilitiesChangedEvent
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

NetworkCapabilitiesChangedEvent

public NetworkCapabilitiesChangedEvent()

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

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

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

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

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 all of the Call Control events defined in this Standard. The call control events are specified in ECMA 269, section 17.2, Table 17-143 "Call Control Events Summary".

Returns:

NetworkCapability

getNetworkInterfaceUsed

public SubjectDeviceID getNetworkInterfaceUsed()

Returns the value of field 'networkInterfaceUsed'. The field 'networkInterfaceUsed' has the following description: Specifies the Network Interface Device (for example, trunk, CO Line) that was selected. Mandatory.

Returns:

SubjectDeviceID

getOutboundConnection

public ConnectionID getOutboundConnection()

Returns the value of field 'outboundConnection'. The field 'outboundConnection' has the following description: Specifies the outbound connection of the network interface device. 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

getProgressIndicator

public ProgressIndicator getProgressIndicator()

Returns the value of field 'progressIndicator'. The field 'progressIndicator' has the following description: Specifies an interworking situation encountered in the public or private network outside the switching sub-domain. As a consequence of entering the network, the level of event reporting associated with this call may be reduced.

This parameter consists of the following components:

1. progressLocation (M) - It may be one of the following:
   • User
   • Private network serving the local user
   • Public network serving the local user
   • Transit network
   • Public network serving the remote user
   • Private network serving the remote user
   • Local interface controlled by the signalling link
   • International Network
   • Network beyond interworking point
   • Other
2. progressDescription (M) - It may be one of the following:
   • ISDN Progress Description - This information is derived from ETSI ETS 300 182: 1993.
   • QSIG Progress Description - This information is derived from ECMA-143.
   • Other

Returns:

ProgressIndicator

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

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'.

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'.

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'.

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 all of the Call Control events defined in this Standard. The call control events are specified in ECMA 269, section 17.2, Table 17-143 "Call Control Events Summary".

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 (for example, trunk, CO Line) that was selected. Mandatory.

Parameters:

networkInterfaceUsed - the value of field 'networkInterfaceUsed'.

setOutboundConnection

public void setOutboundConnection(ConnectionID outboundConnection)

Sets the value of field 'outboundConnection'. The field 'outboundConnection' has the following description: Specifies the outbound connection of the network interface device. 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'.

setProgressIndicator

public void setProgressIndicator(ProgressIndicator progressIndicator)

Sets the value of field 'progressIndicator'. The field 'progressIndicator' has the following description: Specifies an interworking situation encountered in the public or private network outside the switching sub-domain. As a consequence of entering the network, the level of event reporting associated with this call may be reduced.

This parameter consists of the following components:

1. progressLocation (M) - It may be one of the following:
   • User
   • Private network serving the local user
   • Public network serving the local user
   • Transit network
   • Public network serving the remote user
   • Private network serving the remote user
   • Local interface controlled by the signalling link
   • International Network
   • Network beyond interworking point
   • Other
2. progressDescription (M) - It may be one of the following:
   • ISDN Progress Description - This information is derived from ETSI ETS 300 182: 1993.
   • QSIG Progress Description - This information is derived from ECMA-143.
   • Other

Parameters:

progressIndicator - the value of field 'progressIndicator'.

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'.

unmarshalNetworkCapabilitiesChangedEvent

public static NetworkCapabilitiesChangedEvent unmarshalNetworkCapabilitiesChangedEvent(java.io.Reader reader)
                                                                                throws org.exolab.castor.xml.MarshalException,
                                                                                       org.exolab.castor.xml.ValidationException

Method unmarshalNetworkCapabilitiesChangedEvent

Parameters:

reader -

Returns:

NetworkCapabilitiesChangedEvent

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