ch.ecma.csta.binding
Class ConnectionListItem

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

All Implemented Interfaces:

java.io.Serializable

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

Provides the linkage mechanism between a device's old connection ID and new connection ID resulting from the conference or transfer.

The supported parameters for the ConnectionListItem are:

ConnectionListItem Supported Parameters
newConnection	Conditional	The CallID portion of this ConnectionID refers to the resulting call. This parameter is optional for the transferringDevice in the TransferedEvent, otherwise it is mandatory.
endPoint	Optional	For internal calls, this is the representation of the device inside the switching sub-domain. For external calls (incoming or outgoing) this is the representation of the externally located device (if known by the switching function). This component is a character string. The maximum length supported by the switching function is provided via the capabilities exchange services. It may be: of any device identifier format. of the following statuses: "Provided" " Not Known" "Restricted"
associatedNID	Conditional	For external calls (incoming and/or outgoing), this component specifies the Network Interface Device (for example, trunk, CO line) within the switching sub-domain that is associated with the externally located device. In that case the component endPoint DeviceID (if provided) will represent the externally located device. The associatedNID component is mandatory in case of external calls and will be omitted when the device is located inside the switching sub-domain. This component may be: of any device identifier format of the following statuses: "Provided" or "Not Known"

CSTA Functional Requirements:

1. This list should be used by the computing function to associate devices which remain in a call, as a result of a Conference or Transfer, with the connection IDs that are used to manipulate them.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

ConnectionListItem()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
AssociatedNID	getAssociatedNID() Returns the value of field 'associatedNID'.
Endpoint	getEndpoint() Returns the value of field 'endpoint'.
ConnectionID	getNewConnection() Returns the value of field 'newConnection'.
ConnectionID	getOldConnection() Returns the value of field 'oldConnection'.
ConnectionInformation	getResultingConnectionInfo() Returns the value of field 'resultingConnectionInfo'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setAssociatedNID(AssociatedNID associatedNID) Sets the value of field 'associatedNID'.
void	setEndpoint(Endpoint endpoint) Sets the value of field 'endpoint'.
void	setNewConnection(ConnectionID newConnection) Sets the value of field 'newConnection'.
void	setOldConnection(ConnectionID oldConnection) Sets the value of field 'oldConnection'.
void	setResultingConnectionInfo(ConnectionInformation resultingConnectionInfo) Sets the value of field 'resultingConnectionInfo'.
static ConnectionListItem	unmarshalConnectionListItem(java.io.Reader reader) Method unmarshalConnectionListItem
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

ConnectionListItem

public ConnectionListItem()

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

getAssociatedNID

public AssociatedNID getAssociatedNID()

Returns the value of field 'associatedNID'. The field 'associatedNID' has the following description: For external calls (incoming and/or outgoing), this component specifies the Network Interface Device (for example, trunk, CO line) within the switching sub-domain that is associated with the externally located device. In that case the component endPoint DeviceID (if provided) will represent the externally located device. The associatedNID component is mandatory in case of external calls and will be omitted when the device is located inside the switching sub-domain.
This component may be:

• of any device identifier format
• of the following statuses: "Provided" or "Not Known"

Returns:

AssociatedNID

getEndpoint

public Endpoint getEndpoint()

Returns the value of field 'endpoint'. The field 'endpoint' has the following description: For internal calls, this is the representation of the device inside the switching sub-domain. For external calls (incoming or outgoing) this is the representation of the externally located device (if known by the switching function). This component is a character string. The maximum length supported by the switching function is provided via the capabilities exchange services.
It may be:

• of any device identifier format.
• of the following statuses: "Provided" " Not Known" "Restricted"

Returns:

Endpoint

getNewConnection

public ConnectionID getNewConnection()

Returns the value of field 'newConnection'. The field 'newConnection' has the following description: The CallID portion of this ConnectionID refers to the resulting call. This parameter is optional for the transferringDevice in the TransferedEvent, otherwise it is mandatory.

Returns:

ConnectionID

getOldConnection

public ConnectionID getOldConnection()

Returns the value of field 'oldConnection'. The field 'oldConnection' has the following description: The CallID portion of this ConnectionID refers to the original call. This component is mandatory if the switching function previously reported the CallID, otherwise it is optional.

Returns:

ConnectionID

getResultingConnectionInfo

public ConnectionInformation getResultingConnectionInfo()

Returns the value of field 'resultingConnectionInfo'. The field 'resultingConnectionInfo' has the following description: Contains the flow direction and channel characteristics associated with the resulting connection.

Returns:

ConnectionInformation

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

setAssociatedNID

public void setAssociatedNID(AssociatedNID associatedNID)

Sets the value of field 'associatedNID'. The field 'associatedNID' has the following description: For external calls (incoming and/or outgoing), this component specifies the Network Interface Device (for example, trunk, CO line) within the switching sub-domain that is associated with the externally located device. In that case the component endPoint DeviceID (if provided) will represent the externally located device. The associatedNID component is mandatory in case of external calls and will be omitted when the device is located inside the switching sub-domain.
This component may be:

• of any device identifier format
• of the following statuses: "Provided" or "Not Known"

Parameters:

associatedNID - the value of field 'associatedNID'.

setEndpoint

public void setEndpoint(Endpoint endpoint)

Sets the value of field 'endpoint'. The field 'endpoint' has the following description: For internal calls, this is the representation of the device inside the switching sub-domain. For external calls (incoming or outgoing) this is the representation of the externally located device (if known by the switching function). This component is a character string. The maximum length supported by the switching function is provided via the capabilities exchange services.
It may be:

• of any device identifier format.
• of the following statuses: "Provided" " Not Known" "Restricted"

Parameters:

endpoint - the value of field 'endpoint'.

setNewConnection

public void setNewConnection(ConnectionID newConnection)

Sets the value of field 'newConnection'. The field 'newConnection' has the following description: The CallID portion of this ConnectionID refers to the resulting call. This parameter is optional for the transferringDevice in the TransferedEvent, otherwise it is mandatory.

Parameters:

newConnection - the value of field 'newConnection'.

setOldConnection

public void setOldConnection(ConnectionID oldConnection)

Sets the value of field 'oldConnection'. The field 'oldConnection' has the following description: The CallID portion of this ConnectionID refers to the original call. This component is mandatory if the switching function previously reported the CallID, otherwise it is optional.

Parameters:

oldConnection - the value of field 'oldConnection'.

setResultingConnectionInfo

public void setResultingConnectionInfo(ConnectionInformation resultingConnectionInfo)

Sets the value of field 'resultingConnectionInfo'. The field 'resultingConnectionInfo' has the following description: Contains the flow direction and channel characteristics associated with the resulting connection.

Parameters:

resultingConnectionInfo - the value of field 'resultingConnectionInfo'.

unmarshalConnectionListItem

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

Method unmarshalConnectionListItem

Parameters:

reader -

Returns:

ConnectionListItem

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