Interface java.telephony.callcontrol.CallControlTerminal
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface java.telephony.callcontrol.CallControlTerminal

public interface CallControlTerminal
extends Object
extends Terminal
The CallControlTerminal interface extends the core Terminal interface. This interface provides additional Terminal-related functionality for the Call Control package.

The CallControlTerminal permits applications to place a Terminal on hold or take a Terminal off of hold with respect to one of its telephone calls. The CallControlTerminal interface provides the pickup() method for the Call Pickup feature.


Method Index

 o getDoNotDisturb()
Returns true if the do-not-disturb feature is on, false otherwise.
 o pickup(Connection, Address)
pickup() is analogous to TerminalConnection.answer().
 o pickup(TerminalConnection, Address)
pickup() is analogous to TerminalConnection.answer().
 o pickup(Address, Address)
pickup() is analogous to TerminalConnection.answer().
 o pickupFromGroup(String, Address)
pickupFromGroup() is analogous to TerminalConnection.answer().
 o pickupFromGroup(Address)
pickupFromGroup() is analogous to TerminalConnection.answer().
 o setDoNotDisturb(boolean)
Specifices whether the do not disturb feature should be turned on for this terminal.

Methods

 o getDoNotDisturb
  public abstract boolean getDoNotDisturb() throws PlatformException
Returns true if the do-not-disturb feature is on, false otherwise.

Returns:
True if do not disturb is on, false if it is off.
Throws: PlatformException
A platform-specific exception occurred.
 o setDoNotDisturb
  public abstract void setDoNotDisturb(boolean enable) throws PlatformException
Specifices whether the do not disturb feature should be turned on for this terminal. If the first argument, enable, is true, do not disturb is turned on. If enable is false, do not disturb is turned off.

The Provider must in IN_SERVICE as a pre-condition for the method.

  1. (terminal.getProvider()).getState() == IN_SERVICE

If this method returns successfully without throwing an exception, the Provider is still IN_SERVICE and the do not disturb state is set to the argument 'enable' as given in the post-conditions below:

  1. (terminal.getProvider()).getState() == IN_SERVICE
  2. terminal.getDoNotDisturb() == enable

Parameters:
enable - True to turn do not disturb on, false to turn message waiting off.
Throws: PlatformException
A platform-specific exception occurred.
 o pickup
  public abstract TerminalConnection pickup(Connection pickConnection,
                                            Address terminalAddress) throws InvalidArgumentException, InvalidStateException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableException, PlatformException, Exception
pickup() is analogous to TerminalConnection.answer(). The difference is that for answer(), the Terminal that "answers" the Call is the one specified by the TerminalConnection object. For pickup(), "this" Terminal is the one answering the Call. pickup() picks the call from the specified Connection and pulls it to "this" Terminal using the specified Address. Picking up a call changes the state of the Connection from QUEUED or ALERTING to DISCONNECTED (if the Address specified is different than the Address of the Connection) or CONNECTED (if the Address specified is that same as the Address of the Connection). If the Addresses ARE different, a new Connection (to the specified Address) is added to the Call in the CONNECTED state. The TerminalConnections from the original Connection are placed into the DISCONNECTED state. The proper TerminalConnections in the new Connection are created, including the one to "this" Terminal. That TerminalConnection will be in the ACTIVE state and is returned by pickup().

Parameters:
pickConnection - The Connection to be picked.
terminalAddress - The Address associated with the Terminal.
Returns:
s The new TerminalConnection associated with the Terminal.
Throws: InvalidArgumentException
One of the arguments provided is not valid.
Throws: InvalidStateException
The state of some object is not valid as designated by the pre-conditions for this method.
Throws: MethodNotSupportedException
This method is not supported by the implementation.
Throws: PrivilegeViolationException
The application does not have the proper authority to invoke this method.
Throws: ResourceUnavailableException
An internal resource neccessary for the successful invocation of this method is not available.
Throws: PlatformException
A platform-specific exception occurred.
Throws: Exception
An implementation-specific exception occurred.
 o pickup
  public abstract TerminalConnection pickup(TerminalConnection pickTermConn,
                                            Address terminalAddress) throws InvalidArgumentException, InvalidStateException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableException, PlatformException, Exception
pickup() is analogous to TerminalConnection.answer(). The difference is that for answer(), the Terminal that "answers" the Call is the one specified by the TerminalConnection object. For pickup(), "this" Terminal is the one answering the Call. pickup() picks the call from the specified TerminalConnection and pulls it to "this" Terminal using the specified Address. Picking up a call changes the state of the Connection that contains the specified TerminalConnection from QUEUED or ALERTING to DISCONNECTED (if the Address specified is different than the Address of the Connection) or CONNECTED (if the Address specified is that same as the Address of the Connection). If the Addresses ARE different, a new Connection (to the specified Address) is added to the Call in the CONNECTED state. The TerminalConnections from the original Connection are placed into the DISCONNECTED state. The proper TerminalConnections in the new Connection are created, including the one to "this" Terminal. That TerminalConnection will be in the ACTIVE state and is returned by pickup().

Parameters:
pickTermConn - The TerminalConnection to be picked.
terminalAddress - The Address associated with the Terminal.
Returns:
s The new TerminalConnection associated with the Terminal.
Throws: InvalidArgumentException
One of the arguments provided is not valid.
Throws: InvalidStateException
The state of some object is not valid as designated by the pre-conditions for this method.
Throws: MethodNotSupportedException
This method is not supported by the implementation.
Throws: PrivilegeViolationException
The application does not have the proper authority to invoke this method.
Throws: ResourceUnavailableException
An internal resource neccessary for the successful invocation of this method is not available.
Throws: PlatformException
A platform-specific exception occurred.
Throws: Exception
An implementation-specific exception occurred.
 o pickup
  public abstract TerminalConnection pickup(Address pickAddress,
                                            Address terminalAddress) throws InvalidArgumentException, InvalidStateException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableException, PlatformException, Exception
pickup() is analogous to TerminalConnection.answer(). The difference is that for answer(), the Terminal that "answers" the Call is the one specified by the TerminalConnection object. For pickup(), "this" Terminal is the one answering the Call. pickup() picks a call from the specified Address and pulls it to "this" Terminal using the specified Address. There must be at least one Connection at the Address that is QUEUED or ALERTING. If there are multiple Connections in those states, then the implementation will choose one of those Connections (to pick a specific Connection, use the pickup(Connection, Address) form of pickup()). Picking up a call changes the state of the chosen Connection from QUEUED or ALERTING to DISCONNECTED (if the Address specified is different than the Address of the Connection) or CONNECTED (if the Address specified is that same as the Address of the Connection). If the Addresses ARE different, a new Connection (to the specified Address) is added to the Call in the CONNECTED state. The TerminalConnections from the original Connection are placed into the DISCONNECTED state. The proper TerminalConnections in the new Connection are created, including the one to "this" Terminal. That TerminalConnection will be in the ACTIVE state and is returned by pickup().

Parameters:
pickAddress - The Address to be picked.
terminalAddress - The Address associated with the Terminal.
Returns:
s The new TerminalConnection associated with the Terminal.
Throws: InvalidArgumentException
One of the arguments provided is not valid.
Throws: InvalidStateException
The state of some object is not valid as designated by the pre-conditions for this method.
Throws: MethodNotSupportedException
This method is not supported by the implementation.
Throws: PrivilegeViolationException
The application does not have the proper authority to invoke this method.
Throws: ResourceUnavailableException
An internal resource neccessary for the successful invocation of this method is not available.
Throws: PlatformException
A platform-specific exception occurred.
Throws: Exception
An implementation-specific exception occurred.
 o pickupFromGroup
  public abstract TerminalConnection pickupFromGroup(String pickupGroup,
                                                     Address terminalAddress) throws InvalidArgumentException, InvalidStateException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableException, PlatformException, Exception
pickupFromGroup() is analogous to TerminalConnection.answer(). The difference is that for answer(), the Terminal that "answers" the Call is the one specified by the TerminalConnection object. For pickupFromGroup(), "this" Terminal is the one answering the Call. pickupFromGroup() picks a call from the specified pickup group and pulls it to "this" Terminal using the specified Address. There must be at least one Connection at the set of Addresses in the pickup group that is QUEUED or ALERTING. If there are multiple Connections in those states, then the implementation will choose one of those Connections (to pick a specific Connection, use pickup(Connection, Address)). Picking up a call changes the state of the chosen Connection from QUEUED or ALERTING to DISCONNECTED (if the Address specified is different than the Address of the Connection) or CONNECTED (if the Address specified is that same as the Address of the Connection). If the Addresses ARE different, a new Connection (to the specified Address) is added to the Call in the CONNECTED state. The TerminalConnections from the original Connection are placed into the DISCONNECTED state. The proper TerminalConnections in the new Connection are created, including the one to "this" Terminal. That TerminalConnection will be in the ACTIVE state and is returned by pickupFromGroup().

Parameters:
pickupGroup - The pickup group to be picked.
terminalAddress - The Address associated with the Terminal.
Returns:
s The new TerminalConnection associated with the Terminal.
Throws: InvalidArgumentException
One of the arguments provided is not valid.
Throws: InvalidStateException
The state of some object is not valid as designated by the pre-conditions for this method.
Throws: MethodNotSupportedException
This method is not supported by the implementation.
Throws: PrivilegeViolationException
The application does not have the proper authority to invoke this method.
Throws: ResourceUnavailableException
An internal resource neccessary for the successful invocation of this method is not available.
Throws: PlatformException
A platform-specific exception occurred.
Throws: Exception
An implementation-specific exception occurred.
 o pickupFromGroup
  public abstract TerminalConnection pickupFromGroup(Address terminalAddress) throws InvalidArgumentException, InvalidStateException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableException, PlatformException, Exception
pickupFromGroup() is analogous to TerminalConnection.answer(). The difference is that for answer(), the Terminal that "answers" the Call is the one specified by the TerminalConnection object. For pickupFromGroup(), "this" Terminal is the one answering the Call. pickupFromGroup() picks a call from a pickup group that the specified Address is in and pulls it to "this" Terminal using that Address. There must be at least one Connection at the set of Addresses in the pickup group that is QUEUED or ALERTING. If there are multiple Connections in those states, then the implementation will choose one of those Connections (to pick a specific Connection, use pickup(Connection, Address)). Picking up a call changes the state of the chosen Connection from QUEUED or ALERTING to DISCONNECTED (if the Address specified is different than the Address of the Connection) or CONNECTED (if the Address specified is that same as the Address of the Connection). If the Addresses ARE different, a new Connection (to the specified Address) is added to the Call in the CONNECTED state. The TerminalConnections from the original Connection are placed into the DISCONNECTED state. The proper TerminalConnections in the new Connection are created, including the one to "this" Terminal. That TerminalConnection will be in the ACTIVE state and is returned by pickupFromGroup().

Parameters:
terminalAddress - The Address associated with the Terminal.
Returns:
s The new TerminalConnection associated with the Terminal.
Throws: InvalidArgumentException
One of the arguments provided is not valid.
Throws: InvalidStateException
The state of some object is not valid as designated by the pre-conditions for this method.
Throws: MethodNotSupportedException
This method is not supported by the implementation.
Throws: PrivilegeViolationException
The application does not have the proper authority to invoke this method.
Throws: ResourceUnavailableException
An internal resource neccessary for the successful invocation of this method is not available.
Throws: PlatformException
A platform-specific exception occurred.
Throws: Exception
An implementation-specific exception occurred.

All Packages  Class Hierarchy  This Package  Previous  Next  Index