ch.ecma.csta.binding
Class ConferencedEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Indicates that the conferencing device has conferenced itself or another device with an existing call and that no devices have been removed from the resulting call.

The supported parameters for the ConferencedEvent are:

ConferencedEvent Supported Parameters
monitorCrossRefID	Mandatory	Associates the event to an established monitor.
primaryOldCall	Mandatory	Specifies the connection of the primary call.
secondaryOldCall	Conditional	Specifies the connection of the secondary call.
conferencingDevice	Mandatory	Specifies the device ID of the conferencing device.
addedParty	Mandatory	Specifies the device ID of the last device added to the call.
conferenceConnections	Mandatory	Specifies information on each device/ConnectionID in the resulting conference call. Each list item is of type ConnectionListItem.
localConnectionInfo	Conditional	Specifies the local connection state of the device associated with the Monitor Cross Reference ID.
cause	Mandatory	Specifies the reason for the event.

EventCause values:

• ACTIVEPARTICIPATION: SingleStepConference and active participation was selected.
• SILENTPARTICIPATION: SingleStepConference and silent participation was selected.
• NORMAL: The call was parked
• CONFERENCE: This was a multi-step conference

CSTA Functional Requirements:

1. [AVAYA QUALIFIED] According to ECMA 269, the contents of the primaryOldCall and the secondaryOldCall parameters may be either a "fixed view" or a "local view" of the connections at a device before the conference has been completed. This product supports fixed view as defined below.
   
   • fixed view - for each conferenced event generated by monitors placed on different devices in a call, the switching function provides the same information in the primaryOldCall and the secondaryOldCall parameters independent of the monitorType (call or device-type monitor) and independent of the role of the device in the conference (conferencingDevice, addedParty, etc.). The meaning of these parameters for the fixed-view are:
     • primaryOldCall - specifies the first call visible at the conferencingDevice.
     • secondaryOldCall - specifies the second call visible at the conferencingDevice.
2. The conferenceConnections parameter is a list that contains the new ConnectionID and may contain the old ConnectionID, the DeviceID (values such as ANI, etc.), and for externally located devices the associated Network Interface DeviceID.
3. Omitted as it applies to the Computing Function.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

ConferencedEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
SubjectDeviceID	getAddedParty() Returns the value of field 'addedParty'.
CallCharacteristics	getCallCharacteristics() Returns the value of field 'callCharacteristics'.
CallLinkageDataList	getCallLinkageDataList() Returns the value of field 'callLinkageDataList'.
EventCause	getCause() Returns the value of field 'cause'.
ConnectionList	getConferenceConnections() Returns the value of field 'conferenceConnections'.
SubjectDeviceID	getConferencingDevice() Returns the value of field 'conferencingDevice'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
DeviceHistory	getDeviceHistory() Returns the value of field 'deviceHistory'.
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'.
ConnectionID	getPrimaryOldCall() Returns the value of field 'primaryOldCall'.
ConnectionID	getSecondaryOldCall() Returns the value of field 'secondaryOldCall'.
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	setAddedParty(SubjectDeviceID addedParty) Sets the value of field 'addedParty'.
void	setCallCharacteristics(CallCharacteristics callCharacteristics) Sets the value of field 'callCharacteristics'.
void	setCallLinkageDataList(CallLinkageDataList callLinkageDataList) Sets the value of field 'callLinkageDataList'.
void	setCause(EventCause cause) Sets the value of field 'cause'.
void	setConferenceConnections(ConnectionList conferenceConnections) Sets the value of field 'conferenceConnections'.
void	setConferencingDevice(SubjectDeviceID conferencingDevice) Sets the value of field 'conferencingDevice'.
void	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setDeviceHistory(DeviceHistory deviceHistory) Sets the value of field 'deviceHistory'.
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	setPrimaryOldCall(ConnectionID primaryOldCall) Sets the value of field 'primaryOldCall'.
void	setSecondaryOldCall(ConnectionID secondaryOldCall) Sets the value of field 'secondaryOldCall'.
void	setServicesPermitted(ServicesPermitted servicesPermitted) Sets the value of field 'servicesPermitted'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static ConferencedEvent	unmarshalConferencedEvent(java.io.Reader reader) Method unmarshalConferencedEvent
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

ConferencedEvent

public ConferencedEvent()

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

getAddedParty

public SubjectDeviceID getAddedParty()

Returns the value of field 'addedParty'. The field 'addedParty' has the following description: Specifies the device ID of the last device added to the call. Mandatory.

This is of type SubjectDeviceID but note that SubjectDeviceID refers to a parameter type - not the subject device of the Conferenced event. This parameter type is used to represent the two devices in this event because the two devices are affected by the generation of this event (that is, the conferencing device and the addedParty device). However, there is only one device which is the subject of the event and that is the conferencing device. For more details on the SubjectDeviceID parameter type, see Subject Device Id

Returns:

SubjectDeviceID

getCallCharacteristics

public CallCharacteristics getCallCharacteristics()

Returns the value of field 'callCharacteristics'.

Returns:

CallCharacteristics

getCallLinkageDataList

public CallLinkageDataList getCallLinkageDataList()

Returns the value of field 'callLinkageDataList'. The field 'callLinkageDataList' has the following description: Specifies the global call data and thread data associated with the call. This parameter is mandatory if the switching function supports the call linkage feature otherwise it will not be provided. The parameter consists of the following components:

• newCallLinkageData (M) CallLinkageData - specifies the call linkage data associated with the resulting call.
• oldCallLinkageData (M) CallLinkageData - specifies the call linkage data that was discarded as the result of the conference.

Returns:

CallLinkageDataList

getCause

public EventCause getCause()

Returns the value of field 'cause'.

Returns:

EventCause

getConferenceConnections

public ConnectionList getConferenceConnections()

Returns the value of field 'conferenceConnections'. The field 'conferenceConnections' has the following description: Specifies information on each device/ConnectionID in the resulting conference call. Mandatory.

See CSTA Functional Requirements #2.

Returns:

ConnectionList

getConferencingDevice

public SubjectDeviceID getConferencingDevice()

Returns the value of field 'conferencingDevice'. The field 'conferencingDevice' has the following description: Specifies the device ID of the conferencing device. Mandatory.

This is of type SubjectDeviceID but note that SubjectDeviceID refers to a parameter type - not the subject device of the Conferenced event. This parameter type is used to represent the two devices in this event because the two devices are affected by the generation of this event (that is, the conferencing device and the addedParty device). However, there is only one device which is the subject of the event and that is the conferencing device. For more details on the SubjectDeviceID parameter type, see Subject Device Id

Returns:

SubjectDeviceID

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

getDeviceHistory

public DeviceHistory getDeviceHistory()

Returns the value of field 'deviceHistory'.

Returns:

DeviceHistory

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

getPrimaryOldCall

public ConnectionID getPrimaryOldCall()

Returns the value of field 'primaryOldCall'. The field 'primaryOldCall' has the following description: Specifies the connection of the primary call. See Functional Implementation #1. Mandatory.

Returns:

ConnectionID

getSecondaryOldCall

public ConnectionID getSecondaryOldCall()

Returns the value of field 'secondaryOldCall'. The field 'secondaryOldCall' has the following description: Specifies the connection of the secondary call. If the switching function supports the "fixed-view" option (as indicated by the capability exchange services), this parameter is mandatory.

If the switching function supports the "local-view" option, this parameter is mandatory if there are two known calls involved with the conference (before the conference is created) from the perspective of the monitored device, otherwise it will not be provided.

See CSTA Functional Requirements #1.

Returns:

ConnectionID

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

setAddedParty

public void setAddedParty(SubjectDeviceID addedParty)

Sets the value of field 'addedParty'. The field 'addedParty' has the following description: Specifies the device ID of the last device added to the call. Mandatory.

This is of type SubjectDeviceID but note that SubjectDeviceID refers to a parameter type - not the subject device of the Conferenced event. This parameter type is used to represent the two devices in this event because the two devices are affected by the generation of this event (that is, the conferencing device and the addedParty device). However, there is only one device which is the subject of the event and that is the conferencing device. For more details on the SubjectDeviceID parameter type, see Subject Device Id

Parameters:

addedParty - the value of field 'addedParty'.

setCallCharacteristics

public void setCallCharacteristics(CallCharacteristics callCharacteristics)

Sets the value of field 'callCharacteristics'.

Parameters:

callCharacteristics - the value of field 'callCharacteristics'.

setCallLinkageDataList

public void setCallLinkageDataList(CallLinkageDataList callLinkageDataList)

Sets the value of field 'callLinkageDataList'. The field 'callLinkageDataList' has the following description: Specifies the global call data and thread data associated with the call. This parameter is mandatory if the switching function supports the call linkage feature otherwise it will not be provided. The parameter consists of the following components:

• newCallLinkageData (M) CallLinkageData - specifies the call linkage data associated with the resulting call.
• oldCallLinkageData (M) CallLinkageData - specifies the call linkage data that was discarded as the result of the conference.

Parameters:

callLinkageDataList - the value of field 'callLinkageDataList'.

setCause

public void setCause(EventCause cause)

Sets the value of field 'cause'.

Parameters:

cause - the value of field 'cause'.

setConferenceConnections

public void setConferenceConnections(ConnectionList conferenceConnections)

Sets the value of field 'conferenceConnections'. The field 'conferenceConnections' has the following description: Specifies information on each device/ConnectionID in the resulting conference call. Mandatory.

See CSTA Functional Requirements #2.

Parameters:

conferenceConnections - the value of field 'conferenceConnections'.

setConferencingDevice

public void setConferencingDevice(SubjectDeviceID conferencingDevice)

Sets the value of field 'conferencingDevice'. The field 'conferencingDevice' has the following description: Specifies the device ID of the conferencing device. Mandatory.

This is of type SubjectDeviceID but note that SubjectDeviceID refers to a parameter type - not the subject device of the Conferenced event. This parameter type is used to represent the two devices in this event because the two devices are affected by the generation of this event (that is, the conferencing device and the addedParty device). However, there is only one device which is the subject of the event and that is the conferencing device. For more details on the SubjectDeviceID parameter type, see Subject Device Id

Parameters:

conferencingDevice - the value of field 'conferencingDevice'.

setCorrelatorData

public void setCorrelatorData(CorrelatorData correlatorData)

Sets the value of field 'correlatorData'.

Parameters:

correlatorData - the value of field 'correlatorData'.

setDeviceHistory

public void setDeviceHistory(DeviceHistory deviceHistory)

Sets the value of field 'deviceHistory'.

Parameters:

deviceHistory - the value of field 'deviceHistory'.

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

setPrimaryOldCall

public void setPrimaryOldCall(ConnectionID primaryOldCall)

Sets the value of field 'primaryOldCall'. The field 'primaryOldCall' has the following description: Specifies the connection of the primary call. See Functional Implementation #1. Mandatory.

Parameters:

primaryOldCall - the value of field 'primaryOldCall'.

setSecondaryOldCall

public void setSecondaryOldCall(ConnectionID secondaryOldCall)

Sets the value of field 'secondaryOldCall'. The field 'secondaryOldCall' has the following description: Specifies the connection of the secondary call. If the switching function supports the "fixed-view" option (as indicated by the capability exchange services), this parameter is mandatory.

If the switching function supports the "local-view" option, this parameter is mandatory if there are two known calls involved with the conference (before the conference is created) from the perspective of the monitored device, otherwise it will not be provided.

See CSTA Functional Requirements #1.

Parameters:

secondaryOldCall - the value of field 'secondaryOldCall'

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

unmarshalConferencedEvent

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

Method unmarshalConferencedEvent

Parameters:

reader -

Returns:

ConferencedEvent

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