|
JSR-043: JTAPI-1.4 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
CallControlAddress
interface extends the core
Address
interface. It provides additional features on the
Address. Applications may query an Address object using the
instanceof
operator to see whether it supports this interface.
Each Address may have zero or more forwarding instructions. Each
instruction describes how the switching domain should handle incoming
telephone calls to an Address under different circumstances. Examples of
forwarding instructions are "forward all calls to x9999" or "forward all
calls to x7777 when no one answers." Each forwarding instruction is
represented by an instance of the CallControlForwarding
class.
A switching domain will honor forwarding instructions to the extent that
other (possibly higher priority) instructions allow.
Applications assign a list of forwarding instructions via the
the CallControlAddress.setForwarding()
method. To obtain the
current, effective forwarding instructions, applications invoke the
CallControlAddress.getForwarding()
method. To cancel all
forwarding instructions, applications use the
CallControlAddress.cancelForwarding()
method.
CallControlAddress
interface defines two additional
attributes: do-not-disturb and message-waiting.
The do-not-disturb feature gives the means to notify the telephony platform
that an Address does not want to receive incoming telephone calls. That
is, if this feature is activated, the underlying telephony platform will not
alert this Address to incoming telephone calls. Applications use the
CallControlAddress.setDoNotDisturb()
method to activate or
deactivate this feature and the
CallControlAddress.getDoNotDisturb()
method to return the
current state of this attribute.
Note that the CallControlTerminal
interface also has a
do-not-disturb attribute. This gives the ability to control the do not
disturb property at either the Address level (e.g. a phone number) or
at the Terminal level (e.g. an individual phone.)
The message-waiting attribute indicates whether there are messages waiting
for a human user of the Address. These messages may either be maintained
by an application or some telephony platform. Applications inform the
telephony hardware of the message waiting status, and typically the hardware
displays a visible indicator (e.g. an LED) to users. Applications use the
CallControlAddress.setMessageWaiting()
method to activate or
deactivate this feature and the
CallControlAddress.getMessageWaiting()
method to return the
current state of this attribute.
CallControlAddress
interface are
reported via the AddressObserver.addressChangedEvent()
method. The application observer object must also implement the
CallControlCallObserver
interface to express interest in the
call control package events.
The following are the events associated with this interface:
CallCtlAddrDoNotDisturbEv |
Indicates the do-not-disturb feature of this Address has changed. |
CallCtlAddrForwardEv |
Indicates the forwarding characteristics of this Address has changed. |
CallCtlAddrMessageWaitingEv |
Indicates the message waiting characteristics of this Address has changed. |
CallControlTerminal
,
CallControlForwarding
,
CallControlAddressObserver
,
CallCtlAddrDoNotDisturbEv
,
CallCtlAddrForwardEv
,
CallCtlAddrMessageWaitingEv
Method Summary | |
void |
cancelForwarding()
Cancels all of the forwarding instructions on this Address. |
boolean |
getDoNotDisturb()
Returns true if the do-not-disturb feature is activated, false otherwise. |
CallControlForwarding[] |
getForwarding()
Returns an array of forwarding instructions currently effective for this Address. |
boolean |
getMessageWaiting()
Returns true if the message waiting is activated, false otherwise. |
void |
setDoNotDisturb(boolean enable)
Specifies whether the do-not-disturb feature should be activated or deactivated for this Address. |
void |
setForwarding(CallControlForwarding[] instructions)
Sets the forwarding characteristics for this Address. |
void |
setMessageWaiting(boolean enable)
Specifies whether the message-waiting indicator should be activated or deactivated for this Address. |
Methods inherited from interface javax.telephony.Address |
addAddressListener, addCallListener, addCallObserver, addObserver, getAddressCapabilities, getAddressListeners, getCallListeners, getCallObservers, getCapabilities, getConnections, getName, getObservers, getProvider, getTerminals, removeAddressListener, removeCallListener, removeCallObserver, removeObserver |
Method Detail |
public void setForwarding(CallControlForwarding[] instructions) throws MethodNotSupportedException, InvalidStateException, InvalidArgumentException
CallControlForwarding
objects.
Each object describes a different forwarding. This method waits until all
forwarding instructions have been set or until an error occurs and an exception
is thrown.
Pre-conditions:
instructions
- An array of Address forwarding instructionsMethodNotSupportedException
- This method is not supported by the
given implementation.InvalidStateException
- The Provider is not "in service".InvalidArgumentException
- An invalid set of forwarding
instructions were given as a parameter.CallCtlAddrForwardEv
public CallControlForwarding[] getForwarding() throws MethodNotSupportedException
MethodNotSupportedException
- This method is not supported by
the given implementation.public void cancelForwarding() throws MethodNotSupportedException, InvalidStateException
CallControlAddress.getForwarding()
method will return null. This method waits until all forwarding
instructions have been cancelled or until an error occurs and an exception
is thrown.
Pre-conditions:
MethodNotSupportedException
- This method is not supported by the
given implementation.InvalidStateException
- The Provider is not "in service".CallCtlAddrForwardEv
public boolean getDoNotDisturb() throws MethodNotSupportedException
MethodNotSupportedException
- This method is not supported by the
given implementation.public void setDoNotDisturb(boolean enable) throws MethodNotSupportedException, InvalidStateException
Pre-conditions:
enable
- True to activate do-not-disturb, false to deactivate.MethodNotSupportedException
- This method is not supported by the
given implementation.InvalidStateException
- The Provider is not "in service".CallCtlAddrDoNotDisturbEv
public boolean getMessageWaiting() throws MethodNotSupportedException
MethodNotSupportedException
- This method is not supported by the
given implementation.public void setMessageWaiting(boolean enable) throws MethodNotSupportedException, InvalidStateException
Pre-conditions:
enable
- True to activate message-waiting, false to deactivate.MethodNotSupportedException
- This method is not supported by the
given implementation.InvalidStateException
- The Provider is not "in service".CallCtlAddrMessageWaitingEv
|
JSR-043: JTAPI-1.4 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |