hookswitchstateev.java

Java Telephony API .java程序

/*
 * 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 java.telephony.phone.events;

/**
 * The HookswitchStateEv interface extends the PhoneTermEv interface and is
 * reported via the PhoneTermObserver interface. This event interface
 * indicates that the state of the hookswitch component has changed.
 * <p>
 * Applications may obtain the new state of the hookswitch (either on-hook
 * or off-hook) via the <EM>getHookSwitchState()</EM> method on this interface.
 */

public interface HookswitchStateEv extends PhoneTermEv {

  /**
   * Event id
   */
  public static final int ID = 503;

  /**
   * Returns the current state of the hookswitch.
   * <p>
   * @return The current state of the hookswitch.
   */
  public int getHookSwitchState();
}