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.
-
HAND_SET
- The component group is of type HAND_SET.
-
HEAD_SET
- The component group is of type HEAD_SET.
-
OTHER
- The component group is of type OTHER.
-
PHONE_SET
- The componet group is of type PHONE_SET.
-
SPEAKER_PHONE
- The component group is of type SPEAKER_PHONE.
-
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.
-
activate(Address)
- Enables all routing of events or media stream between all Components
of this group and calls to the specified Address.
-
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.
-
deactivate(Address)
- Disables all routing of events or media stream between all Components
of this group and the specified Address.
-
getComponents()
- Returns the groups components, null if the group contains zero components.
-
getDescription()
- Returns a string describing the component group.
-
getType()
- Returns the type of group, either HEAD_SET, HAND_SET, SPEAKER_PHONE,
PHONE_SET or OTHER.
HEAD_SET
public final static int HEAD_SET
- The component group is of type HEAD_SET.
HAND_SET
public final static int HAND_SET
- The component group is of type HAND_SET.
SPEAKER_PHONE
public final static int SPEAKER_PHONE
- The component group is of type SPEAKER_PHONE.
PHONE_SET
public final static int PHONE_SET
- The componet group is of type PHONE_SET.
OTHER
public final static int OTHER
- The component group is of type OTHER.
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.
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.
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.
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.
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.
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.
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