public class AgentTerminalServiceImpl
extends java.lang.Object
implements com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalService
This service models an agent terminal in the system
It provides methods to read and set the attributes of the termianal.
Prerequisites to usage: This represents the minimal data artifacts required to successfully invoke this web service.
SsoToken (Represents a valid CCT user session)
AgentTerminal (An existing terminal)
Operations: View WSDL
| Constructor and Description |
|---|
AgentTerminalServiceImpl() |
| Modifier and Type | Method and Description |
|---|---|
void |
callSupervisor(SsoToken ssoToken,
Terminal terminal,
Address address) |
void |
callSupervisor(TerminalAddressRequest parameters) |
GetActivityCodeResponse |
getActivityCode(SsoToken ssoToken,
Terminal terminal) |
GetActivityCodeResponse |
getActivityCode(TerminalRequest parameters)
Returns the activity code of the specified terminal
|
GetAgentTerminalCapabilitiesResponse |
getCapabilities(TerminalRequest parameters)
Returns the agent terminal capabilities of the specified terminal
|
GetDoNotDisturbResponse |
getDoNotDisturb(TerminalRequest parameters)
Returns the do-not-disturb value of the specified terminal
|
GetLoginIdResponse |
getLoginId(TerminalRequest parameters)
Returns the phone set login id of the agent currently logged into the terminal
|
GetNotReadyReasonCodeResponse |
getNotReadyReasonCode(TerminalRequest parameters)
Returns the value of the specified termials not-ready-reason-code
|
GetRelatedAddressesResponse |
getRelatedAddresses(TerminalRequest parameters)
Returns an array of Address objects associated with this Terminal object
|
GetTerminalConnectionsResponse |
getTerminalConnections(TerminalRequest parameters)
Returns a list of TerminalConnections currently associated with the specified terminal
|
GetVersionResponse |
getVersion(GetVersionRequest parameters) |
IsForwardedResponse |
isForwarded(TerminalRequest parameters)
Returns the value of terminals isForwarded attribute
|
IsReadyResponse |
isReady(SsoToken ssoToken,
Terminal terminal) |
IsReadyResponse |
isReady(TerminalRequest parameters)
Returns the isReady value of the specified terminal
|
void |
login(AgentTerminalLoginRequest parameters)
Logs in an agent to the terminal
|
void |
logout(AgentTerminalLogoutRequest parameters)
Removes any agent from the terminal
|
void |
setActivityCode(SetActivityCodeRequest parameters)
Sets the activity code of the specified terminal
|
void |
setIsReady(BooleanTerminalRequest parameters)
Sets the value of the specified terminal's isReady attribute
|
void |
setNotReadyReasonCode(StringTerminalRequest parameters)
Sets the not ready code of the specified terminal
|
public IsReadyResponse isReady(TerminalRequest parameters) throws SessionNotCreatedException, IsReadyException
Operation Summary:
Returns the isReady value of the specified terminal
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
isReady in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the TerminalRequest specifies the terminalIsReadyResponse contains a boolean value indicating if the isReady attribute is true/false.SessionNotCreatedExceptionIsReadyExceptionpublic IsReadyResponse isReady(SsoToken ssoToken, Terminal terminal) throws SessionNotCreatedException, IsReadyException
public GetActivityCodeResponse getActivityCode(TerminalRequest parameters) throws GetActivityCodeException, SessionNotCreatedException
Operation Summary:
Returns the activity code of the specified terminal
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getActivityCode in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the TerminalRequest specifies the terminalGetActivityCodeResponse contains a string representation of the activity codeGetActivityCodeExceptionSessionNotCreatedExceptionpublic GetActivityCodeResponse getActivityCode(SsoToken ssoToken, Terminal terminal) throws GetActivityCodeException, SessionNotCreatedException
public void setActivityCode(SetActivityCodeRequest parameters) throws SetActivityCodeException, SessionNotCreatedException
Operation Summary:
Sets the activity code of the specified terminal
Sample Usage:
SOAP Request/Response:
Sample Request
setActivityCode in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the SetActivityCodeRequest contains the required terminal and activity codeSetActivityCodeExceptionSessionNotCreatedExceptionpublic IsForwardedResponse isForwarded(TerminalRequest parameters) throws SessionNotCreatedException, IsForwardedException
Operation Summary:
Returns the value of terminals isForwarded attribute
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
isForwarded in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the TerminalRequest specifies the terminalIsForwardedResponse contains a boolean value representing the isForwarded attribute of the terminalSessionNotCreatedExceptionIsForwardedExceptionpublic GetNotReadyReasonCodeResponse getNotReadyReasonCode(TerminalRequest parameters) throws GetNotReadyReasonCodeException, SessionNotCreatedException
Operation Summary:
Returns the value of the specified termials not-ready-reason-code
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getNotReadyReasonCode in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the TerminalRequest specifies the terminalGetNotReadyReasonCodeResponse contains a string representation of the not ready reason code of the terminalGetNotReadyReasonCodeExceptionSessionNotCreatedExceptionpublic void setIsReady(BooleanTerminalRequest parameters) throws SetIsReadyException, SessionNotCreatedException
Operation Summary:
Sets the value of the specified terminal's isReady attribute
Sample Usage:
SOAP Request/Response:
Sample Request
setIsReady in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the BooleanTerminalRequest specified the terminal and the required isReady valueSetIsReadyExceptionSessionNotCreatedExceptionpublic GetTerminalConnectionsResponse getTerminalConnections(TerminalRequest parameters) throws SessionNotCreatedException, GetTerminalConnectionsException
Operation Summary:
Returns a list of TerminalConnections currently associated with the specified terminal
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getTerminalConnections in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the TerminalRequest specifies the terminalGetTerminalConnectionsResponse contains a list of (@link TerminalConnection) objectsSessionNotCreatedExceptionGetTerminalConnectionsExceptionpublic void setNotReadyReasonCode(StringTerminalRequest parameters) throws SessionNotCreatedException, SetNotReadyReasonCodeException
Operation Summary:
Sets the not ready code of the specified terminal
Sample Usage:
SOAP Request/Response:
Sample Request
setNotReadyReasonCode in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the StringTerminalRequest contains the terminal and the value of the not ready code requiredSessionNotCreatedExceptionSetNotReadyReasonCodeExceptionpublic GetAgentTerminalCapabilitiesResponse getCapabilities(TerminalRequest parameters) throws GetCapabilitiesException, SessionNotCreatedException
Operation Summary:
Returns the agent terminal capabilities of the specified terminal. These include:
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getCapabilities in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the TerminalRequest specifies the terminalGetAgentTerminalCapabilitiesResponse contains the (@link AgentTerminalCapabilities)GetCapabilitiesExceptionSessionNotCreatedExceptionpublic GetDoNotDisturbResponse getDoNotDisturb(TerminalRequest parameters) throws GetDoNotDisturbException, SessionNotCreatedException
Operation Summary:
Returns the do-not-disturb value of the specified terminal
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getDoNotDisturb in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the TerminalRequest specifies the terminalGetDoNotDisturbResponse contains a boolean value representing the do not disturb attribute of the terminalGetDoNotDisturbExceptionSessionNotCreatedExceptionpublic GetLoginIdResponse getLoginId(TerminalRequest parameters) throws GetLoginIdException, SessionNotCreatedException
Operation Summary:
Returns the phone set login id of the agent currently logged into the terminal
If no agent is currently logged in a null id will be returned.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getLoginId in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the TerminalRequest specifies the terminalGetLoginIdResponse contains the login idGetLoginIdExceptionSessionNotCreatedExceptionpublic GetRelatedAddressesResponse getRelatedAddresses(TerminalRequest parameters) throws GetRelatedAddressesException, SessionNotCreatedException
Operation Summary:
Returns an array of Address objects associated with this Terminal object
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getRelatedAddresses in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the TerminalRequest specifies the terminalGetRelatedAddressesResponse contains a list of (@link Address) objectsGetRelatedAddressesExceptionSessionNotCreatedExceptionpublic void login(AgentTerminalLoginRequest parameters) throws LoginException, SessionNotCreatedException
Operation Summary:
Logs in the specified agent to the specified terminal
Sample Usage:
SOAP Request/Response:
Sample Request
login in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the AgentTerminalLoginRequest contains the required terminal and agent informationLoginExceptionSessionNotCreatedExceptionpublic void logout(AgentTerminalLogoutRequest parameters) throws SessionNotCreatedException, LogoutException
Operation Summary:
Removes any agents logged into the terminal
Sample Usage:
SOAP Request/Response:
Sample Request
logout in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceparameters - the AgentTerminalLogoutRequest contains the agent terminalSessionNotCreatedExceptionLogoutExceptionpublic GetVersionResponse getVersion(GetVersionRequest parameters) throws GetVersionException, SessionNotCreatedException
getVersion in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceGetVersionExceptionSessionNotCreatedExceptionpublic void callSupervisor(TerminalAddressRequest parameters) throws SessionNotCreatedException, CallSupervisorException
callSupervisor in interface com.nortel.soa.oi.cct.agentterminalservice.AgentTerminalServiceSessionNotCreatedExceptionCallSupervisorExceptionpublic void callSupervisor(SsoToken ssoToken, Terminal terminal, Address address) throws SessionNotCreatedException, CallSupervisorException
Copyright © 2010 All Rights Reserved.