com.genesyslab.ail
Interface AbstractDn

All Superinterfaces:
ConfigObject, ConfigObjectListener, java.util.EventListener, IdObject, Possible
All Known Subinterfaces:
Dn, DnRoutingPoint

public interface AbstractDn
extends Possible, ConfigObject, ConfigObjectListener

The base class of all DNs, including agent and routing DNs.


Nested Class Summary
static class AbstractDn.Status
          Enum for the possible DN status.
static class AbstractDn.Type
          Enum for the possible types of DNs.
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject
IdObject.ObjectType
 
Method Summary
 void activate()
          Explicitly registers to the T-Server.
 void addDnListener(java.lang.Object listener)
          Adds a listener.
 java.lang.String getAlias()
          Returns the alias of this DN as defined in the Configuration Layer.
 java.lang.String getCallableNumber()
          Returns the callable number of this DN.
 java.util.Collection getInteractions()
          Returns the interactions currently active.
 java.lang.String getName()
          Returns this DN's name as defined in the Configuration Layer.
 Switch getSwitch()
          Returns the switch.
 void queryStatus()
          Deprecated.  
 void removeDnListener(java.lang.Object listener)
          Removes a listener.
 void unactivate()
          Explicitly unregisters from the T-Server.
 
Methods inherited from interface com.genesyslab.ail.Possible
arePossible, isPossible
 
Methods inherited from interface com.genesyslab.ail.IdObject
getId, getObjectType
 
Methods inherited from interface com.genesyslab.ail.ConfigObject
exists
 
Methods inherited from interface com.genesyslab.ail.event.ConfigObjectListener
deleted
 

Method Detail

addDnListener

void addDnListener(java.lang.Object listener)
Adds a listener.

Parameters:
listener - either a DnListener or a DnRoutingPointListener.

removeDnListener

void removeDnListener(java.lang.Object listener)
Removes a listener.

Parameters:
listener - a previously added listener.

getSwitch

Switch getSwitch()
Returns the switch.


getInteractions

java.util.Collection getInteractions()
Returns the interactions currently active.

Returns:
a collection of Interaction.

queryStatus

void queryStatus()
Deprecated. 

Requests info from the T-Server.


unactivate

void unactivate()
Explicitly unregisters from the T-Server.
This class registers to T-Server events when you call AilFactory.getDn(java.lang.String) and unregisters when it is garbage-collected. Usually, it keeps listening to T-Server events when it is not used anymore (in order to be up to date on the next registration). But in some cases, this would lead it to take unwanted actions.
Once you have called this method, you must discard all references to this object, or call activate().


activate

void activate()
Explicitly registers to the T-Server.


getCallableNumber

java.lang.String getCallableNumber()
Returns the callable number of this DN. This is the number to dial in order to reach this DN. Use it for making, transferring, conferencing calls, etc. The IdObject.getId() method returns an internal ID, whereas this method returns the DN number that the switch recognizes as a DN target.


getName

java.lang.String getName()
Returns this DN's name as defined in the Configuration Layer.

This name corresponds to the value for the number option value set in the Configuration Layer. This name does not include an "@switch" suffix. Note: By default, use IdObject.getId().


getAlias

java.lang.String getAlias()
Returns the alias of this DN as defined in the Configuration Layer.