ch.ecma.csta.binding
Class ServiceInitiatedEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Not implemented.

Indicates that a device has gone off-hook for service or is being prompted to go off-hook. Iindicates that a telephony service has been initiated at a monitored device. The switching function typically generates this event when "dial-tone" is being provided. This event indicates that either a call may be originated or a feature may be invoked. This event also may indicate that a device is prompting a user.

For an illustration of this event, see ECMA 269, section 17.2.17, Figure 17-49 "Service Initiated Event".

Common situations that generate this event include:

• When a service or feature prompts a user to take a phone off-hook and that phone is not able to do so without manual intervention.
• A MakeCall or ConsultationCall service has been invoked and the originating device is initiating a new call that is associated with the originating device.
• When manually invoking any feature at a device for an existing call that requires a new call to be created to input the feature.
• When a device is taken off-hook manually.
• When an incoming call arrives on a monitored Network Interface Device (for example, trunk, CO line).

A more complete list of causes is found in ECMA 269, section 17.2.17.2, Table 17.177 "Service Initiated - Event Causes".

CSTA Functional Requirements:

1. Some CSTA services (Make Call, Call Back, Pickup, JoinCall) may require you to prompt the user of the targeted device in order to take that device off-hook. In this case a Service Initiated event is generated containing the appropriate cause code (Make Call, Call Back, Call Pickup, Join Call). The implementation of this prompting mechanism is switching function specific (display flashing, ring pattern, lamp blinking, etc.).
2. It is switching function dependent as to whether this event is provided to the computing function. For those switching functions that cannot detect prompting, or a device going off-hook and being provided dialtone, the first event seen by the computing function, for the calling device, will be the OriginatedEvent.
3. When prompting a call appearance, bridged, or hybrid device configuration as a result of a Make Call service request, only one of the appearances (initiatedConnection) will be prompted.
4. When prompting a call appearance, bridged, or hybrid device configuration as a result of a Call Back service request or Recall feature, only the appearance (initiatedConnection) that issued the Call Back service request or that was the Recall device, will be prompted.
5. For an external incoming call, this event is generated at the Network Interface Device (when this device can have monitoring applied to it).
6. It is not required to send the Service Initiated event for functional (for example, en-bloc BRI) terminals nor is it required to be sent for calls that are set up without receiving dial tone or other prompting, like CSTA calls initiated with the Make Call service from a hands-free telephone.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

ServiceInitiatedEvent()

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'.
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'.
ConnectionID	getInitiatedConnection() Returns the value of field 'initiatedConnection'.
ConnectionInformation	getInitiatedConnectionInfo() Returns the value of field 'initiatedConnectionInfo'.
SubjectDeviceID	getInitiatingDevice() Returns the value of field 'initiatingDevice'.
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'.
MessageInfo	getMessageInfo() Returns the value of field 'messageInfo'.
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'.
ServicesPermitted	getServicesPermitted() Returns the value of field 'servicesPermitted'.
java.lang.String	getSubjectOfCall() Returns the value of field 'subjectOfCall'.
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	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	setInitiatedConnection(ConnectionID initiatedConnection) Sets the value of field 'initiatedConnection'.
void	setInitiatedConnectionInfo(ConnectionInformation initiatedConnectionInfo) Sets the value of field 'initiatedConnectionInfo'.
void	setInitiatingDevice(SubjectDeviceID initiatingDevice) Sets the value of field 'initiatingDevice'.
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	setMessageInfo(MessageInfo messageInfo) Sets the value of field 'messageInfo'.
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	setServicesPermitted(ServicesPermitted servicesPermitted) Sets the value of field 'servicesPermitted'.
void	setSubjectOfCall(java.lang.String subjectOfCall) Sets the value of field 'subjectOfCall'.
static ServiceInitiatedEvent	unmarshalServiceInitiatedEvent(java.io.Reader reader) Method unmarshalServiceInitiatedEvent
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

ServiceInitiatedEvent

public ServiceInitiatedEvent()

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

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

getInitiatedConnection

public ConnectionID getInitiatedConnection()

Returns the value of field 'initiatedConnection'. The field 'initiatedConnection' has the following description: Specifies the connection at which service was initiated. Mandatory.

Returns:

ConnectionID

getInitiatedConnectionInfo

public ConnectionInformation getInitiatedConnectionInfo()

Returns the value of field 'initiatedConnectionInfo'. The field 'initiatedConnectionInfo' has the following description: Specifies the connection information associated with the initiatedConnection connection. Optional. If this parameter is not present, then the connection information is switching function specific.

Returns:

ConnectionInformation

getInitiatingDevice

public SubjectDeviceID getInitiatingDevice()

Returns the value of field 'initiatingDevice'. The field 'initiatingDevice' has the following description: Specifies the initiating device. Mandatory.

Returns:

SubjectDeviceID

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

getMessageInfo

public MessageInfo getMessageInfo()

Returns the value of field 'messageInfo'.

Returns:

MessageInfo

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

getServicesPermitted

public ServicesPermitted getServicesPermitted()

Returns the value of field 'servicesPermitted'.

Returns:

ServicesPermitted

getSubjectOfCall

public java.lang.String getSubjectOfCall()

Returns the value of field 'subjectOfCall'.

Returns:

String

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

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

setInitiatedConnection

public void setInitiatedConnection(ConnectionID initiatedConnection)

Sets the value of field 'initiatedConnection'. The field 'initiatedConnection' has the following description: Specifies the connection at which service was initiated. Mandatory.

Parameters:

initiatedConnection - the value of field 'initiatedConnection'.

setInitiatedConnectionInfo

public void setInitiatedConnectionInfo(ConnectionInformation initiatedConnectionInfo)

Sets the value of field 'initiatedConnectionInfo'. The field 'initiatedConnectionInfo' has the following description: Specifies the connection information associated with the initiatedConnection connection. Optional. If this parameter is not present, then the connection information is switching function specific.

Parameters:

initiatedConnectionInfo - the value of field 'initiatedConnectionInfo'.

setInitiatingDevice

public void setInitiatingDevice(SubjectDeviceID initiatingDevice)

Sets the value of field 'initiatingDevice'. The field 'initiatingDevice' has the following description: Specifies the initiating device. Mandatory.

Parameters:

initiatingDevice - the value of field 'initiatingDevice'

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

setMessageInfo

public void setMessageInfo(MessageInfo messageInfo)

Sets the value of field 'messageInfo'.

Parameters:

messageInfo - the value of field 'messageInfo'.

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

setServicesPermitted

public void setServicesPermitted(ServicesPermitted servicesPermitted)

Sets the value of field 'servicesPermitted'.

Parameters:

servicesPermitted - the value of field 'servicesPermitted'.

setSubjectOfCall

public void setSubjectOfCall(java.lang.String subjectOfCall)

Sets the value of field 'subjectOfCall'.

Parameters:

subjectOfCall - the value of field 'subjectOfCall'.

unmarshalServiceInitiatedEvent

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

Method unmarshalServiceInitiatedEvent

Parameters:

reader -

Returns:

ServiceInitiatedEvent

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