Interface java.telephony.callcontrol.CallControlAddress
All Packages Class Hierarchy This Package Previous Next Index
Interface java.telephony.callcontrol.CallControlAddress
- public interface CallControlAddress
- extends Object
- extends Address
The CallControlAddress interface extends the core Address interface. It
provides additional methods which perform more advanced features on a
per-address basis.
These additional methods include setting the forwarding characteristics,
the do-not-disturb characteristics, and the message waiting characteristics.
-
cancelForwarding()
- Cancels all of the forwarding instructions on this Address.
-
getDoNotDisturb()
- Returns true if the do-not-disturb feature is on, false otherwise.
-
getForwarding()
- Returns an array of forwarding instructions currently set for this
telephone Address.
-
getMessageWaiting()
- Returns true if message waiting is turned on, false otherwise.
-
setDoNotDisturb(boolean)
- Specifices whether the do not disturb feature should be turned on for
this address.
-
setForwarding(CallControlForwarding[])
- Sets the forwarding characteristics for this telephony Address.
-
setMessageWaiting(boolean)
- Specifices whether the message waiting feature should be turned on for
this address.
setForwarding
public abstract void setForwarding(CallControlForwarding instructions[]) throws PlatformException
- Sets the forwarding characteristics for this telephony Address. This
forwarding command cancels all previous forwarding instructions. This
method takes an array of CallControlForwarding object. Each object
describe a different rule for different types of forwarding.
- Parameters:
- instructions - An array of address forwarding instructions
- Throws: PlatformException
- A platform-specific exception occurred.
getForwarding
public abstract CallControlForwarding[] getForwarding() throws PlatformException
- Returns an array of forwarding instructions currently set for this
telephone Address. If there are no instructions, this method returns null.
- Returns:
- An array of address forwarding instructions, null if there are
none.
- Throws: PlatformException
- A platform-specific exception occurred.
cancelForwarding
public abstract void cancelForwarding() throws PlatformException
- Cancels all of the forwarding instructions on this Address. When this
method completes, the getForwarding() will return null.
- Throws: PlatformException
- A platform-specific exception occurred.
getDoNotDisturb
public abstract boolean getDoNotDisturb() throws PlatformException
- Returns true if the do-not-disturb feature is on, false otherwise. The
Provider must be IN_SERVICE
- Returns:
- True if do not disturb is on, false if it is off.
- Throws: PlatformException
- A platform-specific exception occurred.
setDoNotDisturb
public abstract void setDoNotDisturb(boolean enable) throws PlatformException
- Specifices whether the do not disturb feature should be turned on for
this address. 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.
- (address.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:
- (address.getProvider()).getState() == IN_SERVICE
- address.getDoNotDisturb() == enable
- Parameters:
- enable - True to turn do not disturb on, false to turn message
waiting off.
- Throws: PlatformException
- A platform-specific exception occurred.
getMessageWaiting
public abstract boolean getMessageWaiting() throws PlatformException
- Returns true if message waiting is turned on, false otherwise. The
Provider must be IN_SERVICE.
- Returns:
- True if message waiting is on, false if it is off.
- Throws: PlatformException
- A platform-specific exception occurred.
setMessageWaiting
public abstract void setMessageWaiting(boolean enable) throws PlatformException
- Specifices whether the message waiting feature should be turned on for
this address. If the first argument, enable, is true, message waiting is
turned on. If enable is false, message waiting is turned off.
The Provider must in IN_SERVICE as a pre-condition for the method.
- (address.getProvider()).getState() == IN_SERVICE
If this method returns successfully without throwing an exception, the
Provider is still IN_SERVICE and the message waiting state is set to
the argument 'enable' as given in the post-conditions below:
- (address.getProvider()).getState() == IN_SERVICE
- address.getMessageWaiting() == enable
- Parameters:
- enable - True to turn message waiting on, false to turn message
waiting off.
- Throws: PlatformException
- A platform-specific exception occurred.
All Packages Class Hierarchy This Package Previous Next Index