javax.telephony.privatedata
Interface PrivateData

All Known Implementing Classes:
com.avaya.jtapi.tsapi.TsapiTerminalConnection

public interface PrivateData

Introduction

The private data mechanism in JTAPI is a means by which applications can send platform-specific messages to the underlying telephone platform. The PrivateData interface may be implemented on any JTAPI object. Applications may query an object to see if it supports this interface via the instanceof operator. This interface makes no attempt to interpret the data sent to the underlying platform.

Note: Use of this interface interferes with application portability across different JTAPI implementations. Applications which make use of this interface may not work properly with other JTAPI-compliant implementations.

Setting vs. Sending Private Data

There are two ways in which information is sent to the platform. Applications can set a piece of data to be associated with the next method invocation on the object. The data is only valid for the next method invocation on the same object. This data is not transmitted to the underlying platform until the next method is invoked. Also, applications may immediately send a piece of data to the underlying platform. This data is not associated with any future method invocation.

Private Data Events

Implementations may also send platform-specific events to the application. Each individual object carries its own private data event. The data carried in these objects are specific to the implementation. The private data event interfaces defined are: PrivateAddrEv, PrivateCallEv, PrivateProvEv, and PrivateTermEv

See Also:
PrivateDataCapabilities, PrivateAddrEv, PrivateCallEv, PrivateProvEv, PrivateTermEv

Method Summary
 java.lang.Object getPrivateData()
          Returns some platform-specific data associated with the last method that was invoked on the object for which this PrivateData is implemented.
 java.lang.Object sendPrivateData(java.lang.Object data)
          Immediately performs some platform-specific action.
 void setPrivateData(java.lang.Object data)
          Associates some platform-specific data with the next method that is invoked on the object for which this interface is implemented.
 

Method Detail

setPrivateData

public void setPrivateData(java.lang.Object data)
Associates some platform-specific data with the next method that is invoked on the object for which this interface is implemented. The format of this data and the manner in which it modifies the method invocation is platform-dependent. This data applies to the next method invocation ONLY and does not affect any future method invocations.

Parameters:
data - The platform-dependent data.

getPrivateData

public java.lang.Object getPrivateData()
Returns some platform-specific data associated with the last method that was invoked on the object for which this PrivateData is implemented. The format of this data is platform-dependent. This data pertains to the last method invocation ONLY.

Returns:
Object The platform-dependent data.
Since:
JTAPI v1.2

sendPrivateData

public java.lang.Object sendPrivateData(java.lang.Object data)
Immediately performs some platform-specific action. The effect of this methods invocation is immediate and does not directly relate to any future object method invocations. The action taken upon receipt of this data is platform-dependent as is the format of the data itself. This method returns the platform-dependent data actually sent.

Parameters:
data - The platform-dependent data.
Returns:
The platform-dependent data sent.


Copyright © 2005 Avaya All Rights Reserved.