/*
#pragma ident "@(#)PrivateAddrEv.java	1.3      96/11/03     SMI"

 * Copyright (c) 1996 Sun Microsystems, Inc. All Rights Reserved.
 *
 * Permission to use, copy, modify, and distribute this software
 * and its documentation for NON-COMMERCIAL purposes and without
 * fee is hereby granted provided that this copyright notice
 * appears in all copies. Please refer to the file "copyright.html"
 * for further important copyright and licensing information.
 *
 * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF
 * THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
 * TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR
 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.
 */

package javax.telephony.privatedata.events;
import  javax.telephony.events.AddrEv;

/**
 * The <CODE>PrivateAddrEv</CODE> interface sends platform-specific event
 * information to an <CODE>AddressObserver</CODE>. This interface extends the
 * core <CODE>AddrEv</CODE> interface. This interface could be a stand-alone
 * event for private data that is not associated with any other event. This
 * interface could also be used to extend any other event for private data.
 * <p>
 * When used as a stand-alone event, the ID returned by <CODE>Ev.getID()</CODE>
 * should be the ID defined in this interface. When used to extend another
 * event to add private data to that event, the ID returned by
 * <CODE>Ev.getID()</CODE> should be the ID defined in the other event
 * interface.
 * <p>
 * @see javax.telephony.events.AddrEv
 * @see javax.telephony.AddressObserver
 * @see javax.telephony.privatedata.PrivateData
 * @deprecated as of JTAPI 1.4, replaced by {@link javax.telephony.privatedata.PrivateDataEvent}
 */

public interface PrivateAddrEv extends AddrEv {

  /**
   * The Event ID.
   * <p>
   * @since JTAPI v1.2
   */
  public static final int ID = 600;


  /**
   * Returns platform-specific information to the application. The format of
   * the data and the action that should be taken upon receipt of the data is
   * platform-dependent.
   * <p>
   * @return The platform-specific data.
   */
  public java.lang.Object getPrivateData();
}

