Interface java.telephony.phone.ComponentGroup
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface java.telephony.phone.ComponentGroup

public interface ComponentGroup
extends Object
A ComponentGroup is a grouping of Component objects. Terminals may be composed of zero or more ComponentGroups. Applications query the PhoneTerminal interface for the available ComponentGroups. Then they query this interface for the components which make up this component group.

Variable Index

 o HAND_SET
The component group is of type HAND_SET.
 o HEAD_SET
The component group is of type HEAD_SET.
 o OTHER
The component group is of type OTHER.
 o PHONE_SET
The componet group is of type PHONE_SET.
 o SPEAKER_PHONE
The component group is of type SPEAKER_PHONE.

Method Index

 o activate()
Enables all routing of events or media stream between all Components of this group and calls on any of the Addresses asociated with the parent Terminal.
 o activate(Address)
Enables all routing of events or media stream between all Components of this group and calls to the specified Address.
 o deactivate()
Disables all routing of events or media stream between all Components of this group and calls on any of the Addresses associated with the parent Terminal.
 o deactivate(Address)
Disables all routing of events or media stream between all Components of this group and the specified Address.
 o getComponents()
Returns the groups components, null if the group contains zero components.
 o getDescription()
Returns a string describing the component group.
 o getType()
Returns the type of group, either HEAD_SET, HAND_SET, SPEAKER_PHONE, PHONE_SET or OTHER.

Variables

 o HEAD_SET
  public final static int HEAD_SET
The component group is of type HEAD_SET.
 o HAND_SET
  public final static int HAND_SET
The component group is of type HAND_SET.
 o SPEAKER_PHONE
  public final static int SPEAKER_PHONE
The component group is of type SPEAKER_PHONE.
 o PHONE_SET
  public final static int PHONE_SET
The componet group is of type PHONE_SET.
 o OTHER
  public final static int OTHER
The component group is of type OTHER.

Methods

 o getType
  public abstract int getType() throws PlatformException
Returns the type of group, either HEAD_SET, HAND_SET, SPEAKER_PHONE, PHONE_SET or OTHER.

Returns:
The type of group.
Throws: PlatformException
A platform-specific exception occurred.
 o getDescription
  public abstract String getDescription() throws PlatformException
Returns a string describing the component group.

Returns:
A string description of the component group.
Throws: PlatformException
A platform-specific exception occurred.
 o getComponents
  public abstract Component[] getComponents() throws PlatformException
Returns the groups components, null if the group contains zero components.

Returns:
An array of Component objects.
Throws: PlatformException
A platform-specific exception occurred.
 o activate
  public abstract boolean activate() throws PlatformException
Enables all routing of events or media stream between all Components of this group and calls on any of the Addresses asociated with the parent Terminal.

Returns:
true if successful and false if unsuccessful.
Throws: PlatformException
A platform-specific exception occurred.
 o deactivate
  public abstract boolean deactivate() throws PlatformException
Disables all routing of events or media stream between all Components of this group and calls on any of the Addresses associated with the parent Terminal.

Returns:
true if successful and false if unsuccessful.
Throws: PlatformException
A platform-specific exception occurred.
 o activate
  public abstract boolean activate(Address address) throws InvalidArgumentException, PlatformException
Enables all routing of events or media stream between all Components of this group and calls to the specified Address.

Parameters:
address - The Address that the group is to be activated on.
Returns:
true if successful and false if unsuccessful.
Throws: InvalidArgumentException
The provided Address is not valid for the Terminal.
Throws: PlatformException
A platform-specific exception occurred.
 o deactivate
  public abstract boolean deactivate(Address address) throws InvalidArgumentException, PlatformException
Disables all routing of events or media stream between all Components of this group and the specified Address.

Parameters:
address - The Address that the group is to be deactivated on.
Returns:
true if successful and false if unsuccessful.
Throws: InvalidArgumentException
The provided Address is not valid for the Terminal.
Throws: PlatformException
A platform-specific exception occurred.

All Packages  Class Hierarchy  This Package  Previous  Next  Index