public class AgentServiceImpl
extends java.lang.Object
implements com.nortel.soa.oi.cct.agentservice.AgentService
This service models an Agent in the system
It provides agent related functionality such as login/logout as well as methods
for querying or manipulating data related to a given agent.
Each Agent has properties that can be accessed and/or updated.
The collection of operations exposed by this AgentService represent a platform neutral means to achieve this.
Prerequisites to usage: This represents the minimal data artifacts required to successfully invoke this web service.
Operations: View WSDL
Constructor and Description |
---|
AgentServiceImpl() |
Modifier and Type | Method and Description |
---|---|
GetAgentACWEnabledStatusResponse |
getAgentACWEnabledStatus(GetAgentACWEnabledStatusRequest parameters) |
GetAgentsResponse |
getAgents(AgentRequest parameters)
Returns the list of agents under a given supervisor
|
GetCapabilitiesResponse |
getCapabilities(AgentRequest parameters)
Returns the capabilities of the specified agent
|
GetAgentContactTypesResponse |
getContactTypes(AgentRequest parameters)
Retrieves the contact types associated with an agent
|
GetNotificationResponse |
getNotification(AgentRequest parameters)
Retrieves the Notification property associated with an agent
|
StringResponse |
getNotReadyReasonCode(AgentRequest parameters)
Returns the not ready reason code for the specified agent
|
GetPrivilegesResponse |
getPrivileges(AgentRequest parameters)
Returns the privileges of the specified agent
|
GetStaticVoiceTerminalResponse |
getStaticVoiceTerminal(AgentRequest parameters)
Retrieve the specified agent's static voice terminal
|
GetSupervisorResponse |
getSupervisor(AgentRequest parameters)
Returns the specified agents supervisor
|
StringResponse |
getType(AgentRequest parameters)
Returns the type of the specified agent
|
GetVersionResponse |
getVersion(GetVersionRequest parameters) |
BooleanResponse |
isLoggedIn(AgentRequest parameters)
Determines if the specified agent is logged in
|
BooleanResponse |
isReady(AgentRequest parameters)
Returns the ready status of the specified agent
|
BooleanResponse |
isSupervisor(AgentRequest parameters)
Returns if the specified Agent is a supervisor or not
|
void |
login(LoginRequest parameters)
Logs in the specified agent
|
void |
logout(AgentRequest parameters)
Logs out the specified agent from the system
|
RetrieveResponse |
retrieve(RetrieveRequest parameters)
Retrives a contact based on the specified contactExternalId
|
void |
setNotification(SetNotificationRequest parameters)
Sets the Notification property of the specified agent
|
void |
setNotReadyReasonCode(SetNotReadyReasonCodeRequest parameters)
Sets the specified agent's not ready reason code
|
void |
setReady(SetReadyRequest parameters)
Sets the ready status of the specified agent
|
void |
setStaticVoiceTerminal(SetStaticVoiceTerminalRequest parameters)
Configure the static voice terminal for the specified agent
|
void |
setSupervisor(SetSupervisorRequest parameters)
Sets the supervisor of the specified agent
|
public GetAgentContactTypesResponse getContactTypes(AgentRequest parameters) throws GetContactTypesException, SessionNotCreatedException
Operation Summary:
Retrieve the contact types associated with the specified agent.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getContactTypes
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationGetAgentContactTypesResponse
the ContactType
associated with the Agent
GetContactTypesException
SessionNotCreatedException
public GetStaticVoiceTerminalResponse getStaticVoiceTerminal(AgentRequest parameters) throws SessionNotCreatedException, GetStaticVoiceTerminalException
Operation Summary:
Retrieve the agents passive terminal.
GetStaticVoiceTerminalException will be thrown if the agent does not have a passive terminal set.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getStaticVoiceTerminal
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationGetStaticVoiceTerminalResponse
the Terminal
associated with the Agent
SessionNotCreatedException
GetStaticVoiceTerminalException
public void setStaticVoiceTerminal(SetStaticVoiceTerminalRequest parameters) throws SessionNotCreatedException, SetStaticVoiceTerminalException
Operation Summary:
Sets the agents passive voice terminal.
Sample Usage:
SOAP Request/Response:
Sample Request
setStaticVoiceTerminal
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationSessionNotCreatedException
SetStaticVoiceTerminalException
public BooleanResponse isReady(AgentRequest parameters) throws SessionNotCreatedException, IsReadyException
Operation Summary:
Determines if the agent is ready, returns true/false in a boolean response.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
isReady
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationBooleanResponse
contains the ready status (true/false) of the Agent
SessionNotCreatedException
IsReadyException
public void login(LoginRequest parameters) throws LoginException, SessionNotCreatedException
Operation Summary:
Logs in the Agent to the system.
Sample Usage:
SOAP Request/Response:
Sample Request
login
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationLoginException
SessionNotCreatedException
public void setReady(SetReadyRequest parameters) throws SetReadyException, SessionNotCreatedException
Operation Summary:
Sets the agent's ready status
Sample Usage:
SOAP Request/Response:
Sample Request
setReady
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the SetReadyRequest
containing the agent informationSetReadyException
SessionNotCreatedException
public void setNotification(SetNotificationRequest parameters) throws SetNotificationException, SessionNotCreatedException
Operation Summary:
Sets the agent's Notification property
Sample Usage:
SOAP Request/Response:
Sample Request
setNotification
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the SetNotificationRequest
containing the agent informationSetNotificationException
SessionNotCreatedException
public GetNotificationResponse getNotification(AgentRequest parameters) throws GetNotificationException, SessionNotCreatedException
Operation Summary:
Retrieve the Notification property associated with the specified agent.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getNotification
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationGetNotificationsResponse
the ContactType
associated with the Agent
GetNotificationException
SessionNotCreatedException
public RetrieveResponse retrieve(RetrieveRequest parameters) throws RetrieveException, SessionNotCreatedException
Operation Summary:
Attempts to retrieve a contact based on the specified contactExternalId
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
retrieve
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the RetrieveRequest
contains the agent details and the required externalContactId of the contact to be retrievedRetrieveResponse
contains the retrieved contactRetrieveException
SessionNotCreatedException
public BooleanResponse isSupervisor(AgentRequest parameters) throws SessionNotCreatedException, IsSupervisorException
Operation Summary:
Returns if the specified Agent is a supervisor or not
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
isSupervisor
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationBooleanResponse
specifies true if the agent is a supervisor, otherwise falseSessionNotCreatedException
IsSupervisorException
public StringResponse getNotReadyReasonCode(AgentRequest parameters) throws GetNotReadyReasonCodeException, SessionNotCreatedException
Operation Summary:
Returns the not ready reason code for the agent, may be a null string if code is not set
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getNotReadyReasonCode
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationStringResponse
contains the not ready reason code of the agentGetNotReadyReasonCodeException
SessionNotCreatedException
public BooleanResponse isLoggedIn(AgentRequest parameters) throws IsLoggedInException, SessionNotCreatedException
Operation Summary:
Returns true in a BooleanResponse object if the specified agent is logged in
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
isLoggedIn
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationBooleanResponse
contains a value true if the agent is logged in, otherwise false.IsLoggedInException
SessionNotCreatedException
public GetSupervisorResponse getSupervisor(AgentRequest parameters) throws GetSupervisorException, SessionNotCreatedException
Operation Summary:
Returns the agent that is the supervisor of the specified agent
Null may be returned for the supervisor agent object if supervisor is not configured
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getSupervisor
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationGetSupervisorResponse
contains the agent that is the supervisor of the agent specified in the requestGetSupervisorException
SessionNotCreatedException
public void setSupervisor(SetSupervisorRequest parameters) throws SetSupervisorException, SessionNotCreatedException
Operation Summary:
Sets the supervisor of the specified agent
The supervisor specified must exist, otherwise an SetSupervisorException will be thrown.
Sample Usage:
SOAP Request/Response:
Sample Request
setSupervisor
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the SetSupervisorRequest
Contains the agent and the supervisor detailsSetSupervisorException
SessionNotCreatedException
public GetAgentsResponse getAgents(AgentRequest parameters) throws GetAgentsException, SessionNotCreatedException
Operation Summary:
Returns the list of agents under a given supervisor
If the agent specified is not a supervisor a GetAgentsException will be thrown
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getAgents
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationGetAgentsResponse
contains the list of agentsGetAgentsException
SessionNotCreatedException
public void logout(AgentRequest parameters) throws SessionNotCreatedException, LogoutException
Operation Summary:
Logs out the specified agent from the system
An exception will be thrown if the agent is not logged in / has no associated terminals.
Sample Usage:
SOAP Request/Response:
Sample Request
logout
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationSessionNotCreatedException
LogoutException
public StringResponse getType(AgentRequest parameters) throws GetTypeException, SessionNotCreatedException
Operation Summary:
Returns the agent type, agent types are:
AGENT, AGENT_SUPERVISOR or SUPERVISOR
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getType
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationStringResponse
contains the type informationGetTypeException
SessionNotCreatedException
public void setNotReadyReasonCode(SetNotReadyReasonCodeRequest parameters) throws SessionNotCreatedException, SetNotReadyReasonCodeException
Operation Summary:
Sets the specified agent's not ready reason code
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
setNotReadyReasonCode
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the SetNotReadyReasonCodeRequest
contains the specified agent information and the not ready reason codeSessionNotCreatedException
SetNotReadyReasonCodeException
public GetCapabilitiesResponse getCapabilities(AgentRequest parameters) throws GetCapabilitiesException, SessionNotCreatedException
Operation Summary:
Returns the agent capabilities, agent capabilities returned are:
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getCapabilities
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationGetCapabilitiesResponse
contains the agent capabilitiesGetCapabilitiesException
SessionNotCreatedException
public GetVersionResponse getVersion(GetVersionRequest parameters) throws GetVersionException, SessionNotCreatedException
getVersion
in interface com.nortel.soa.oi.cct.agentservice.AgentService
GetVersionException
SessionNotCreatedException
public GetAgentACWEnabledStatusResponse getAgentACWEnabledStatus(GetAgentACWEnabledStatusRequest parameters) throws GetAgentACWEnabledStatusException, SessionNotCreatedException
getAgentACWEnabledStatus
in interface com.nortel.soa.oi.cct.agentservice.AgentService
GetAgentACWEnabledStatusException
SessionNotCreatedException
public GetPrivilegesResponse getPrivileges(AgentRequest parameters) throws GetPrivilegesException, SessionNotCreatedException
Operation Summary:
Returns the agent privileges, agent privileges returned are:
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getPrivileges
in interface com.nortel.soa.oi.cct.agentservice.AgentService
parameters
- the AgentRequest
containing the agent informationGetPrivilegesResponse
contains the agent privilegesGetPrivilegesException
SessionNotCreatedException
Copyright © 2010 All Rights Reserved.