ch.ecma.csta.binding
Class OfferedEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Not implemented.

Indicates that a call is in a pre-delivery state at a device (prior to ringing indication or delivering ringback, for example). The Offered event indicates that the connection is in the Offered mode of the Alerting state. This indicates that a call is in a pre-delivery state.

In this pre-delivery state, the opportunity exists for a computing function to issue one of a set of supported services (for example, Accept Call, Clear Connection ("reject"), Deflect Call) or an ISDN device to accept or reject the call. From the calling side perspective, the call is not delivered at the called device. As a consequence, delivery information such as Ringback indication and/or Network signalling is not provided. For example, the device makes no ringing sounds while in the Offered mode of the Alerting state.

The connection may transit to the Ringing mode of the Alerting state after the call is accepted (See ECMA 269, Section 17.1.1, AcceptCall) or after a time out period, for example.

For an illustration of this event, see ECMA 269, section 17.2.13, Figure 17-45 "Offered Event".

A complete list of causes can be found in ECMA 269, section 17.2.13.2, Table 17.169 "Offered - Event Causes".

CSTA Functional Requirements:

1. Switching function implementations vary in their support for call control services while the Offered mode of the alerting state. The computing function will determine supported services for Offered mode through the capabilities exchange services.
2. The switching function may support an Offered mode time-out. For example, if no service is applied to the connection within an switching function-specific period, it will transit from the Offered mode to the Ringing mode of the alerting state.
3. If there is more than one calling device (that is, a conference calling back to a device), then the originatingNIDConnection parameter will not be present.
4. When a call is offered to a bridged device configuration, multiple Offered events are sent (one for each appearance of the device configuration).

   Each event will contain the following type of information:

   • The event for the appearance which is offered the call first will have the appropriate event cause on why the call is being offered to the device configuration. All subsequence events for the other appearances will have an event cause of Key Operation.
   • The offeredConnection will be the connection identifier of the specific appearance.
   • The offeredDevice, will depend on the type of referencing model that is supported by the switching function (refer to ECMA 269, Section 6.1.7, "Referencing Devices, Elements, Appearances and Device Configurations").
   • The calledDevice or associatedCalledDevice will contain the device identifier associated with the logical element of the device.
5. 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 offeredDevice, 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.
6. 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

OfferedEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
AssociatedCalledDeviceID	getAssociatedCalledDevice() Returns the value of field 'associatedCalledDevice'.
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'.
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'.
RedirectionDeviceID	getLastRedirectionDevice() Returns the value of field 'lastRedirectionDevice'.
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'.
ConnectionID	getOfferedConnection() Returns the value of field 'offeredConnection'.
ConnectionInformation	getOfferedConnectionInfo() Returns the value of field 'offeredConnectionInfo'.
SubjectDeviceID	getOfferedDevice() Returns the value of field 'offeredDevice'.
ConnectionID	getOriginatingNIDConnection() Returns the value of field 'originatingNIDConnection'.
ServicesPermitted	getServicesPermitted() Returns the value of field 'servicesPermitted'.
java.lang.String	getSubjectOfCall() Returns the value of field 'subjectOfCall'.
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	setAssociatedCalledDevice(AssociatedCalledDeviceID associatedCalledDevice) Sets the value of field 'associatedCalledDevice'.
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	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	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	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	setOfferedConnection(ConnectionID offeredConnection) Sets the value of field 'offeredConnection'.
void	setOfferedConnectionInfo(ConnectionInformation offeredConnectionInfo) Sets the value of field 'offeredConnectionInfo'.
void	setOfferedDevice(SubjectDeviceID offeredDevice) Sets the value of field 'offeredDevice'.
void	setOriginatingNIDConnection(ConnectionID originatingNIDConnection) Sets the value of field 'originatingNIDConnection'.
void	setServicesPermitted(ServicesPermitted servicesPermitted) Sets the value of field 'servicesPermitted'.
void	setSubjectOfCall(java.lang.String subjectOfCall) Sets the value of field 'subjectOfCall'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static OfferedEvent	unmarshalOfferedEvent(java.io.Reader reader) Method unmarshalOfferedEvent
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

OfferedEvent

public OfferedEvent()

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

getAssociatedCalledDevice

public AssociatedCalledDeviceID getAssociatedCalledDevice()

Returns the value of field 'associatedCalledDevice'.

Returns:

AssociatedCalledDeviceID

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

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

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

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

getOfferedConnection

public ConnectionID getOfferedConnection()

Returns the value of field 'offeredConnection'. The field 'offeredConnection' has the following description: Specifies the connection that is alerting. Mandatory.

Returns:

ConnectionID

getOfferedConnectionInfo

public ConnectionInformation getOfferedConnectionInfo()

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

Returns:

ConnectionInformation

getOfferedDevice

public SubjectDeviceID getOfferedDevice()

Returns the value of field 'offeredDevice'. The field 'offeredDevice' has the following description: Specifies the device that is alerting. Mandatory.

Returns:

SubjectDeviceID

getOriginatingNIDConnection

public ConnectionID getOriginatingNIDConnection()

Returns the value of field 'originatingNIDConnection'. The field 'originatingNIDConnection' has the following description: Specifies the connection of the Network Interface Device (NID) that the call originated from. Optional.

If this parameter is supported, it will be provided if there is an originating NID associated with the call, otherwise it will not be provided.

See CSTA Functional Requirements #3.

Returns:

ConnectionID

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

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

setAssociatedCalledDevice

public void setAssociatedCalledDevice(AssociatedCalledDeviceID associatedCalledDevice)

Sets the value of field 'associatedCalledDevice'.

Parameters:

associatedCalledDevice - the value of field 'associatedCalledDevice'.

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

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

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

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

setOfferedConnection

public void setOfferedConnection(ConnectionID offeredConnection)

Sets the value of field 'offeredConnection'. The field 'offeredConnection' has the following description: Specifies the connection that is alerting. Mandatory.

Parameters:

offeredConnection - the value of field 'offeredConnection'.

setOfferedConnectionInfo

public void setOfferedConnectionInfo(ConnectionInformation offeredConnectionInfo)

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

Parameters:

offeredConnectionInfo - the value of field 'offeredConnectionInfo'.

setOfferedDevice

public void setOfferedDevice(SubjectDeviceID offeredDevice)

Sets the value of field 'offeredDevice'. The field 'offeredDevice' has the following description: Specifies the device that is alerting. Mandatory.

Parameters:

offeredDevice - the value of field 'offeredDevice'.

setOriginatingNIDConnection

public void setOriginatingNIDConnection(ConnectionID originatingNIDConnection)

Sets the value of field 'originatingNIDConnection'. The field 'originatingNIDConnection' has the following description: Specifies the connection of the Network Interface Device (NID) that the call originated from. Optional.

If this parameter is supported, it will be provided if there is an originating NID associated with the call, otherwise it will not be provided.

See CSTA Functional Requirements #3.

Parameters:

originatingNIDConnection - the value of field 'originatingNIDConnection'.

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

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalOfferedEvent

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

Method unmarshalOfferedEvent

Parameters:

reader -

Returns:

OfferedEvent

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