JSR-043: JTAPI-1.4

javax.telephony.callcontrol.capabilities
Interface CallControlTerminalCapabilities

All Superinterfaces:
TerminalCapabilities

public interface CallControlTerminalCapabilities
extends TerminalCapabilities

The CallControlTerminalCapabilities interface extends the core TerminalCapabilities interface. This interface provides methods to reflect the capabilities of the methods on the CallControlTerminal interface.

The Provider.getTerminalCapabilities() method returns the static Terminal capabilities, and the Terminal.getCapabilities() method returns the dynamic Terminal capabilities. The object returned from each of these methods can be queried with the instanceof operator to check if it supports this interface. This same interface is used to reflect both static and dynamic Terminal capabilities.

See Also:
Provider, Terminal, TerminalCapabilities

Method Summary
 boolean canGetDoNotDisturb()
          Returns true if the application can obtain the do not disturb state, false otherwise.
 boolean canPickup()
          Deprecated. Since JTAPI v1.2. The default behavior of this method in JTAPI v1.2 and later should invoke the canPickup(Connection, Address) method.
 boolean canPickup(Address address1, Address address2)
          Returns true if the application can invoke the overloaded pickup feature which takes two Addresses as arguments, false otherwise.
 boolean canPickup(Connection connection, Address address)
          Returns true if the application can invoke the overloaded pickup feature which takes a Connection and an Address as arguments, false otherwise.
 boolean canPickup(TerminalConnection tc, Address address)
          Returns true if the application can invoke the overloaded pickup feature which takes a TerminalConnection and an Address as arguments, false otherwise.
 boolean canPickupFromGroup()
          Deprecated. Since JTAPI v1.2. The default behavior of this method in JTAPI v1.2 and later should invoke the canPickupFromGroup(String, Address) method.
 boolean canPickupFromGroup(Address address)
          Returns true if the application can invoke the pickup from group feature which takes an Address as an argument, false otherwise.
 boolean canPickupFromGroup(java.lang.String group, Address address)
          Returns true if the application can invoke the pickup from group feature which takes a string pickup group code and an Address as arguments, false otherwise.
 boolean canSetDoNotDisturb()
          Returns true if the application can set the do not disturb state, false otherwise.
 
Methods inherited from interface javax.telephony.capabilities.TerminalCapabilities
isObservable
 

Method Detail

canGetDoNotDisturb

public boolean canGetDoNotDisturb()
Returns true if the application can obtain the do not disturb state, false otherwise.

Returns:
True if the application can obtain the do not disturb state, false otherwise.

canSetDoNotDisturb

public boolean canSetDoNotDisturb()
Returns true if the application can set the do not disturb state, false otherwise.

Returns:
True if the application can set the do not disturb state, false otherwise.

canPickup

public boolean canPickup()
Deprecated. Since JTAPI v1.2. The default behavior of this method in JTAPI v1.2 and later should invoke the canPickup(Connection, Address) method.

Returns true if the application can invoke the pickup feature, false otherwise.

Note: This method has been replaced in JTAPI 1.2 with overloaded versions. These versions permit applications to give typed argument to obtain the capabilities for a particular overloaded version of the CallControlTerminal.pickup() method.

Returns:
True if the application can invoke the pickup feature, false otherwise.

canPickup

public boolean canPickup(Connection connection,
                         Address address)
Returns true if the application can invoke the overloaded pickup feature which takes a Connection and an Address as arguments, false otherwise.

The arguments provided are for typing purposes only. The particular instances of the objects given are ignored and not used to determine the capability outcome is any way.

Parameters:
connection - This argument is used for typing information to determine the overloaded version of the pickup() method.
address - This argument is used for typing information to determine the overloaded version of the pickup() method.
Returns:
True if the application can invoke the pickup feature which takes a Connection and an Address as arguments, false otherwise.
Since:
JTAPI v1.2

canPickup

public boolean canPickup(TerminalConnection tc,
                         Address address)
Returns true if the application can invoke the overloaded pickup feature which takes a TerminalConnection and an Address as arguments, false otherwise.

The arguments provided are for typing purposes only. The particular instances of the objects given are ignored and not used to determine the capability outcome is any way.

Parameters:
tc - This argument is used for typing information to determine the overloaded version of the pickup() method.
address - This argument is used for typing information to determine the overloaded version of the pickup() method.
Returns:
True if the application can invoke the pickup feature which takes a TerminalConnection and an Address as arguments, false otherwise.
Since:
JTAPI v1.2

canPickup

public boolean canPickup(Address address1,
                         Address address2)
Returns true if the application can invoke the overloaded pickup feature which takes two Addresses as arguments, false otherwise.

The arguments provided are for typing purposes only. The particular instances of the objects given are ignored and not used to determine the capability outcome is any way.

Parameters:
address1 - This argument is used for typing information to determine the overloaded version of the pickup() method.
address2 - This argument is used for typing information to determine the overloaded version of the pickup() method.
Returns:
True if the application can invoke the pickup feature which takes two Addresses as arguments, false otherwise.
Since:
JTAPI v1.2

canPickupFromGroup

public boolean canPickupFromGroup()
Deprecated. Since JTAPI v1.2. The default behavior of this method in JTAPI v1.2 and later should invoke the canPickupFromGroup(String, Address) method.

Returns true if the application can invoke the pickup from group feature, false otherwise.

Note: This method has been replaced in JTAPI 1.2 with overloaded versions. These versions permit applications to give typed argument to obtain the capabilities for a particular overloaded version of the CallControlTerminal.pickupFromGroup() method.

Returns:
True if the application can invoke the pickup from group feature, false otherwise.

canPickupFromGroup

public boolean canPickupFromGroup(java.lang.String group,
                                  Address address)
Returns true if the application can invoke the pickup from group feature which takes a string pickup group code and an Address as arguments, false otherwise.

The arguments provided are for typing purposes only. The particular instances of the objects given are ignored and not used to determine the capability outcome is any way.

Parameters:
group - This argument is used for typing information to determine the overloaded version of the pickupFromGroup() method.
address - This argument is used for typing information to determine the overloaded version of the pickupFromGroup() method.
Returns:
True if the application can invoke the pickup from group feature which takes a string pickup group code and an Address as arguments, false otherwise.
Since:
JTAPI v1.2

canPickupFromGroup

public boolean canPickupFromGroup(Address address)
Returns true if the application can invoke the pickup from group feature which takes an Address as an argument, false otherwise.

The arguments provided are for typing purposes only. The particular instances of the objects given are ignored and not used to determine the capability outcome is any way.

Parameters:
address - This argument is used for typing information to determine the overloaded version of the pickupFromGroup() method.
Returns:
True if the application can invoke the pickup from group feature which takes an Address as an argument, false otherwise.
Since:
JTAPI v1.2

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org