com.avaya.jtapi.tsapi
Interface LucentV5TerminalEx

All Superinterfaces:

AgentTerminal, CallControlTerminal, ITsapiTerminal, LucentTerminal, LucentV5Terminal, Terminal

public interface LucentV5TerminalEx
extends LucentV5Terminal

This interface extends LucentV5Terminal with additional features specific to DEFINITY G3 PBX Driver Version 5 private data. When a Provider is bound to a DEFINITY switch which supports V5 private data, this interface may be used to access additional capabilities. This interface provides a removeAgent method which takes an int reasonCode, so an application can specify a reasonCode when the application removes the agent and in effect logs the agent out.

Method Summary

void	removeAgent(Agent agent, int reasonCode) This method overrides AgentTerminal.removeAgent() to add an additional Avaya DEFINITY G3 PBX Driver Version 5 private data-specific parameter reasonCode.

Methods inherited from interface com.avaya.jtapi.tsapi.LucentV5Terminal

addAgent

Methods inherited from interface com.avaya.jtapi.tsapi.LucentTerminal

addAgent, getDirectoryName

Methods inherited from interface javax.telephony.Terminal

addCallListener, addCallObserver, addObserver, addTerminalListener, getAddresses, getCallListeners, getCallObservers, getCapabilities, getName, getObservers, getProvider, getTerminalCapabilities, getTerminalConnections, getTerminalListeners, removeCallListener, removeCallObserver, removeObserver, removeTerminalListener

Methods inherited from interface javax.telephony.callcontrol.CallControlTerminal

getDoNotDisturb, pickup, pickup, pickup, pickupFromGroup, pickupFromGroup, setDoNotDisturb

Methods inherited from interface javax.telephony.Terminal

addCallListener, addCallObserver, addObserver, addTerminalListener, getAddresses, getCallListeners, getCallObservers, getCapabilities, getName, getObservers, getProvider, getTerminalCapabilities, getTerminalConnections, getTerminalListeners, removeCallListener, removeCallObserver, removeObserver, removeTerminalListener

Methods inherited from interface javax.telephony.callcenter.AgentTerminal

addAgent, getAgents, removeAgent, setAgents

Methods inherited from interface javax.telephony.Terminal

addCallListener, addCallObserver, addObserver, addTerminalListener, getAddresses, getCallListeners, getCallObservers, getCapabilities, getName, getObservers, getProvider, getTerminalCapabilities, getTerminalConnections, getTerminalListeners, removeCallListener, removeCallObserver, removeObserver, removeTerminalListener

Method Detail

removeAgent

void removeAgent(Agent agent,
                 int reasonCode)
                 throws TsapiInvalidArgumentException,
                        TsapiInvalidStateException

This method overrides AgentTerminal.removeAgent() to add an additional Avaya DEFINITY G3 PBX Driver Version 5 private data-specific parameter reasonCode. This is important because when an agent is logged out by removing the agent from the AgentTerminal, private data Version 5 provides the ability to specify a reasonCode. That capability is exposed with this method.

Parameters:

agent - An Agent object representing the association between this AgentTerminal and the ACDAddress that should be ended by logging out the agent.

reasonCode - an int conveying to an Application-defined reason code (1-9), or 0 for "no reason".

Throws:

TsapiInvalidArgumentException - At least one of the arguments provided is not valid.

TsapiInvalidStateException - The state of the AgentTerminal is not in a state in which it can be logged out of the ACDAddress.