javax.telephony.phone
Interface ComponentGroup

public interface ComponentGroup

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.

Field Summary

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

Method Summary

boolean	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.
boolean	activate(Address address) Enables all routing of events or media stream between all Components of this group and calls to the specified Address.
boolean	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.
boolean	deactivate(Address address) Disables all routing of events or media stream between all Components of this group and the specified Address.
ComponentGroupCapabilities	getCapabilities() Returns the dynamic capabilities for this ComponentGroup instance.
Component[]	getComponents() Returns the groups components, null if the group contains zero components.
java.lang.String	getDescription() Returns a string describing the component group.
int	getType() Returns the type of group, either HEAD_SET, HAND_SET, SPEAKER_PHONE, PHONE_SET or OTHER.

Field Detail

HEAD_SET

public static final int HEAD_SET

The component group is of type HEAD_SET.

HAND_SET

public static final int HAND_SET

The component group is of type HAND_SET.

SPEAKER_PHONE

public static final int SPEAKER_PHONE

The component group is of type SPEAKER_PHONE.

PHONE_SET

public static final int PHONE_SET

The componet group is of type PHONE_SET.

OTHER

public static final int OTHER

The component group is of type OTHER.

Method Detail

getType

public int getType()

Returns the type of group, either HEAD_SET, HAND_SET, SPEAKER_PHONE, PHONE_SET or OTHER.

Returns:

The type of group.

getDescription

public java.lang.String getDescription()

Returns a string describing the component group.

Returns:

A string description of the component group.

getComponents

public Component[] getComponents()

Returns the groups components, null if the group contains zero components.

Returns:

An array of Component objects.

activate

public boolean 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.

Returns:

true if successful and false if unsuccessful.

deactivate

public boolean 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.

Returns:

true if successful and false if unsuccessful.

activate

public boolean activate(Address address)
                 throws InvalidArgumentException

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.

deactivate

public boolean deactivate(Address address)
                   throws InvalidArgumentException

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.

getCapabilities

public ComponentGroupCapabilities getCapabilities()

Returns the dynamic capabilities for this ComponentGroup instance. Static capabilities are not available for component groups.

Returns:

The dynamic component group capabilities.