com.avaya.jtapi.tsapi
Interface LucentV5Terminal

All Superinterfaces:

AgentTerminal, CallControlTerminal, ITsapiTerminal, LucentTerminal, Terminal

All Known Subinterfaces:

LucentV5TerminalEx

public interface LucentV5Terminal

extends LucentTerminal

The LucentV5Terminal interface extends the LucentTerminal interface.

Method Summary

Agent

addAgent(LucentAddress agentAddress, ACDAddress acdAddress, int initialState, int workMode, int reasonCode, java.lang.String agentID, java.lang.String password) This method overrides Terminal.addAgent() to add the Avaya DEFINITY G3 PBX Driver Version 5 private data-specific parameter reasonCode.

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.callcenter.AgentTerminal

addAgent, getAgents, removeAgent, setAgents

Method Detail

addAgent

public Agent addAgent(LucentAddress agentAddress,
                      ACDAddress acdAddress,
                      int initialState,
                      int workMode,
                      int reasonCode,
                      java.lang.String agentID,
                      java.lang.String password)
               throws TsapiInvalidArgumentException,
                      TsapiInvalidStateException

This method overrides Terminal.addAgent() to add the Avaya DEFINITY G3 PBX Driver Version 5 private data-specific parameter reasonCode. It creates an Agent object, adds it to this AgentTerminal and returns the Agent object.

An Agent object represents an AgentTerminal logged into an ACDAddress.

If the getAgents() method is invoked subsequently it will return this Agent object.

The Agent can be removed from this AgentTerminal by invoking the removeAgent() method.

The pre-condition predicates for this method are:
1. this.getProvider().getState() == IN_SERVICE

The post-condition predicates for this method are:
1. this.getProvider().getState() == IN_SERVICE
2. (this.getAgents() union agent) == agent
3. agent.getStateInfo == initial state and workMode ( specified as a parameter )

Parameters:

agentAddress - specifies that Address on this Terminal that this request is for, where the Terminal may support several addresses.

acdAddress - specifies the address of the ACD that the Terminal is requested to be logged in to (may be null).

initialState - specifies the initial state of the agent. Valid states are Agent.READY, Agent.NOT_READY and Agent.LOG_IN.

workMode - specifies the work mode this Agent should be set to. Valid workModes are LucentAgent.MODE_AUTO_IN and LucentAgent.MODE_MANUAL_IN.

reasonCode - Application-defined reason code (1-9).

agentID - is the Agent's ID.

password - is the Agent's password.

Returns:

An Agent object representing the association between this AgentTerminal and the ACDAddress specified in the request.

Throws:

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

TsapiInvalidStateException - Implementation determined AgentTerminal was in an invalid state for this method.