com.arunta.app.remote
Interface TRAgentServiceRI

All Superinterfaces:
java.rmi.Remote

public interface TRAgentServiceRI
extends java.rmi.Remote

Total Recall VR remote interface for call center agent applications.

This is a simplified system service which provides skeleton interface for applications used by call center agents.


Method Summary
 void addNote(java.lang.String securityKey, java.lang.String extension, java.lang.String note)
          Replaces the notes for the call being recorded with the specified note.
 AgentConfiguration getAgentConfiguration(java.lang.String securityKey)
          Fetches the active Agent Configuration.
 ExtensionRecordingSettings getExtensionSettings(java.lang.String securityKey, java.lang.String extension)
          Fetches the active recording policy that applies to the specified extension.
 boolean isAuthorizedAgent(java.lang.String agentName, java.lang.String pin)
          Tests if the supplied agent credentials will be accepted by the Total Recall VR system.
 com.arunta.app.remote.LoginReturn logon(java.lang.String pin, java.lang.String agentName, java.lang.String agentPassword, java.lang.String extension)
          Remote agent log-on.
 boolean logout(java.lang.String securityKey, java.lang.String agentName, java.lang.String extension)
          Remote agent logout.
 void toggleRecording(java.lang.String securityKey, java.lang.String extension)
          Recording control.
 

Method Detail

isAuthorizedAgent

boolean isAuthorizedAgent(java.lang.String agentName,
                          java.lang.String pin)
                          throws java.rmi.RemoteException
Tests if the supplied agent credentials will be accepted by the Total Recall VR system.

Parameters:
agentName - An agent name.
pin - A pin (password).
Returns:
true if the system will accept the login credentials. false otherwise.
Throws:
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

logon

com.arunta.app.remote.LoginReturn logon(java.lang.String pin,
                                        java.lang.String agentName,
                                        java.lang.String agentPassword,
                                        java.lang.String extension)
                                        throws SecurityException,
                                               java.rmi.RemoteException
Remote agent log-on.

This method is used to establish a trust relationship between the remote client and the Total Recall VR system. The client needs to provide a pin which must match either the administrator or the user password (pin) on the Total Recall VR system. If the pin matches one of the passwords on the Total Recall VR system, then the Total Recall VR system will provide the client with a security key which is a combination of the agent name and the privileges that the client has on the system. This security key must be used by the client in all future requests.

The Total Recall VR Installation and Administration documentation contains information on how to configure agents.

Parameters:
pin - A pin which should match the administrator or the user password (pin) on the Total Recall VR system.
agentName - Valid agent name.
agentPassword - Valid agent password.
extension - The extension number which the agent will use to process calls.
Returns:
A bean that describes the status of the login attempt.
Throws:
SecurityException - If the Total Recall VR system can not grant user level privileges to the agent because the pin and name combination is invalid.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

logout

boolean logout(java.lang.String securityKey,
               java.lang.String agentName,
               java.lang.String extension)
               throws SecurityException,
                      java.rmi.RemoteException
Remote agent logout.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
agentName - The agent name used at login time.
extension - The extension number used at login time.
Returns:
true if successful. false otherwise.
Throws:
SecurityException - On invalid security key, or if the agent that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

toggleRecording

void toggleRecording(java.lang.String securityKey,
                     java.lang.String extension)
                     throws SecurityException,
                            java.rmi.RemoteException
Recording control.

This request toggles recoding on the specified extension. If recording is active, then this request will cease recording, and vice versa.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
extension - The extension number used at login time.
Throws:
SecurityException - On invalid security key, or if the agent that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

addNote

void addNote(java.lang.String securityKey,
             java.lang.String extension,
             java.lang.String note)
             throws SecurityException,
                    java.rmi.RemoteException
Replaces the notes for the call being recorded with the specified note.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
extension - The extension number used at login time.
note - To note to attach to the call. Limit to 256 characters.
Throws:
SecurityException - On invalid security key, or if the agent that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getExtensionSettings

ExtensionRecordingSettings getExtensionSettings(java.lang.String securityKey,
                                                java.lang.String extension)
                                                throws SecurityException,
                                                       java.rmi.RemoteException
Fetches the active recording policy that applies to the specified extension.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
extension - The extension number used at login time.
Returns:
Bean that describes the active recoding policy for the extension.
Throws:
SecurityException - On invalid security key, or if the agent that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getAgentConfiguration

AgentConfiguration getAgentConfiguration(java.lang.String securityKey)
                                         throws SecurityException,
                                                java.rmi.RemoteException
Fetches the active Agent Configuration.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
Returns:
Teh active Agent Configuration.
Throws:
SecurityException - On invalid security key, or if the agent that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.


Copyright ©, 2005-2012 Prolancer Pty Ltd, Sydney Australia.