Interface IOxeSynchro

All Superinterfaces:

IDisposable, IEntity

public interface IOxeSynchro
extends IEntity

Contains functionality used by the Alcatel OmniPCX Enterprise switch OxeSynchro application

Method Summary

Modifier and Type	Method	Description
void	addAgentOperationListener(AgentOperationListener listener)	Registers the AgentOperationListener.
void	addOxeExtensionOperationListener(OxeExtensionOperationListener listener)	Registers the OxeExtensionOperationListener.
void	addOxeRoutingPointOperationListener(OxeRoutingPointOperationListener listener)	Registers the OxeRoutingPointOperationListener.
void	addOxeSwitchOperationListener(OxeSwitchOperationListener listener)	Registers the OxeSwitchOperationListener.
void	addOxeSynchroConfigurationListener(OxeSynchroConfigurationListener listener)	Registers the OxeSynchroConfigurationListener.
void	addOxeSynchroDashboardOperationListener(OxeSynchroDashboardOperationListener listener)	Registers the OxeSynchroDashboardOperationListener.
void	addProcessTraceConfigurationListener(ProcessTraceConfigurationListener listener)	Registers the ProcessTraceConfigurationListener.
int	createOxeSynchroDashboard(String switchName, OxeSynchroDashboardRequest request)	Creates a OxeSynchro dashboard entry.
void	createOxeSynchroEventLog(SystemEventSeverity severity, OxeSynchroEventLog type, OxeSynchroEventLogQualifier[] qualifiers)	Creates an OxeSynchro event log
void	deleteOxeSynchroDashboardById(String switchName, int dashboardId)	Deletes a dashboard entry.
void	deleteOxeSynchroDashboardBySql(String switchName, String sql)	Deletes a dashboard entry.
OxeAgentExtensionData	getAgentExtensionById(String switchName, int id)	Gets the agent extension.
OxeAgentExtensionData	getAgentExtensionByNumber(String switchName, String number)	Gets the agent extension.
IInstance	getInstance()	Returns the instance.
OxeSwitchData	getOxeSwitchById(int switchId)	Gets the data of a switch.
OxeSwitchData	getOxeSwitchByName(String switchName)	Gets the data of a switch.
OxeSwitchData[]	getOxeSwitches()	Get the list of OXE switches.
OxeSynchroConfiguration	getOxeSynchroConfiguration()	Gets the configuration data of the OxeSynchro application.
OxeSynchroDashboardData	getOxeSynchroDashboard(String switchName, int dashboardId)	Gets the data of a dashboard entry.
IOxeSynchroDashboardCursor	getOxeSynchroDashboardCursor(int cursorId)	Gets an OxeSynchro dashboard entry cursor.
IOxeSynchroDashboardCursor[]	getOxeSynchroDashboardCursors()	Returns the OxeSynchro dashboard entry cursors open in the instance.
TableSchema	getOxeSynchroDashboardTableSchema()	Gets the table schema of the OxeSynchro dashboard entry.
ProcessTraceConfiguration	getOxeSynchroProcessTraceConfiguration()	Gets the OxeSynchro process trace configuration.
OxePhoneSetType[]	getPhoneSetTypesWithAcdLogin()	Returns the list of phone set types with "ACD Login" feature.
SwitchDeviceData	getRoutingPointById(String switchName, int id)	Gets the switch device.
SwitchDeviceData	getRoutingPointByNumber(String switchName, String number)	Gets the switch device.
IOxeSynchroDashboardCursor	newOxeSynchroDashboardCursor(String switchName, String[] columns, String sql)	Opens an OxeSynchro dashboard entry cursor.
void	removeAgentOperationListener(AgentOperationListener listener)	Unregisters the AgentOperationListener.
void	removeOxeExtensionOperationListener(OxeExtensionOperationListener listener)	Unregisters the OxeExtensionOperationListener.
void	removeOxeRoutingPointOperationListener(OxeRoutingPointOperationListener listener)	Unregisters the OxeRoutingPointOperationListener.
void	removeOxeSwitchOperationListener(OxeSwitchOperationListener listener)	Unregisters the OxeSwitchOperationListener.
void	removeOxeSynchroConfigurationListener(OxeSynchroConfigurationListener listener)	Unregisters the OxeSynchroConfigurationListener.
void	removeOxeSynchroDashboardOperationListener(OxeSynchroDashboardOperationListener listener)	Unregisters the OxeSynchroDashboardOperationListener.
void	removeProcessTraceConfigurationListener(ProcessTraceConfigurationListener listener)	Unregisters the ProcessTraceConfigurationListener.
OxeAgentExtensionData	tryGetAgentExtensionById(String switchName, int id)	Gets the agent extension or null if it doesn't exist.
OxeAgentExtensionData	tryGetAgentExtensionByNumber(String switchName, String number)	Gets the agent extension or null if it doesn't exist.
IOxeSynchroDashboardCursor	tryGetOxeSynchroDashboardCursor(int cursorId)	Gets an OxeSynchro dashboard entry cursor open in the instance or null if it doesn't exist.
SwitchDeviceData	tryGetRoutingPointById(String switchName, int id)	Gets the switch device or null if it doesn't exist.
SwitchDeviceData	tryGetRoutingPointByNumber(String switchName, String number)	Gets the switch device or null if it doesn't exist.
OxeSwitchOperationResult	updateOxeSwitch(String switchName, OxeSwitchRequest request)	Updates a switch.
void	updateOxeSynchroDashboard(String switchName, int dashboardId, OxeSynchroDashboardRequest request)	Updates a dashboard entry.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

addAgentOperationListener

void addAgentOperationListener(AgentOperationListener listener)

Registers the AgentOperationListener.

Parameters:

listener - Event listener to add.

removeAgentOperationListener

void removeAgentOperationListener(AgentOperationListener listener)

Unregisters the AgentOperationListener.

Parameters:

listener - Event listener to remove.

addOxeExtensionOperationListener

void addOxeExtensionOperationListener(OxeExtensionOperationListener listener)

Registers the OxeExtensionOperationListener.

Parameters:

listener - Event listener to add.

removeOxeExtensionOperationListener

void removeOxeExtensionOperationListener(OxeExtensionOperationListener listener)

Unregisters the OxeExtensionOperationListener.

Parameters:

listener - Event listener to remove.

addOxeRoutingPointOperationListener

void addOxeRoutingPointOperationListener(OxeRoutingPointOperationListener listener)

Registers the OxeRoutingPointOperationListener.

Parameters:

listener - Event listener to add.

removeOxeRoutingPointOperationListener

void removeOxeRoutingPointOperationListener(OxeRoutingPointOperationListener listener)

Unregisters the OxeRoutingPointOperationListener.

Parameters:

listener - Event listener to remove.

addOxeSwitchOperationListener

void addOxeSwitchOperationListener(OxeSwitchOperationListener listener)

Registers the OxeSwitchOperationListener.

Parameters:

listener - Event listener to add.

removeOxeSwitchOperationListener

void removeOxeSwitchOperationListener(OxeSwitchOperationListener listener)

Unregisters the OxeSwitchOperationListener.

Parameters:

listener - Event listener to remove.

addOxeSynchroConfigurationListener

void addOxeSynchroConfigurationListener(OxeSynchroConfigurationListener listener)

Registers the OxeSynchroConfigurationListener.

Parameters:

listener - Event listener to add.

removeOxeSynchroConfigurationListener

void removeOxeSynchroConfigurationListener(OxeSynchroConfigurationListener listener)

Unregisters the OxeSynchroConfigurationListener.

Parameters:

listener - Event listener to remove.

addOxeSynchroDashboardOperationListener

void addOxeSynchroDashboardOperationListener(OxeSynchroDashboardOperationListener listener)

Registers the OxeSynchroDashboardOperationListener.

Parameters:

listener - Event listener to add.

removeOxeSynchroDashboardOperationListener

void removeOxeSynchroDashboardOperationListener(OxeSynchroDashboardOperationListener listener)

Unregisters the OxeSynchroDashboardOperationListener.

Parameters:

listener - Event listener to remove.

addProcessTraceConfigurationListener

void addProcessTraceConfigurationListener(ProcessTraceConfigurationListener listener)

Registers the ProcessTraceConfigurationListener.

Parameters:

listener - Event listener to add.

removeProcessTraceConfigurationListener

void removeProcessTraceConfigurationListener(ProcessTraceConfigurationListener listener)

Unregisters the ProcessTraceConfigurationListener.

Parameters:

listener - Event listener to remove.

createOxeSynchroDashboard

int createOxeSynchroDashboard(String switchName,
 OxeSynchroDashboardRequest request)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a OxeSynchro dashboard entry.

Parameters:

switchName - Name of the OXE switch.

request - Contains the dashboard entry data.

Returns:

Identifier of the created dashboard entry.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createOxeSynchroEventLog

void createOxeSynchroEventLog(SystemEventSeverity severity,
 OxeSynchroEventLog type,
 OxeSynchroEventLogQualifier[] qualifiers)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Creates an OxeSynchro event log

Parameters:

severity - System event severity

type - OxeSynchro event log

qualifiers - OxeSynchro event log qualifiers

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteOxeSynchroDashboardById

void deleteOxeSynchroDashboardById(String switchName,
 int dashboardId)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a dashboard entry.

Parameters:

switchName - Name of the OXE switch.

dashboardId - Identifier of the dashboard entry.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteOxeSynchroDashboardBySql

void deleteOxeSynchroDashboardBySql(String switchName,
 String sql)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a dashboard entry.

Parameters:

switchName - Name of the OXE switch.

sql - Sql-like statement. The columns admitted are the ones returned by the GetOxeSynchroDashboardTableSchema method. If null then all dashboard entries are deleted.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentExtensionById

OxeAgentExtensionData getAgentExtensionById(String switchName,
 int id)
                                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the agent extension.

Parameters:

switchName - Name of the switch.

id - Identifier of the agent extension.

Returns:

The object OxeAgentExtensionData.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentExtensionByNumber

OxeAgentExtensionData getAgentExtensionByNumber(String switchName,
 String number)
                                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the agent extension.

Parameters:

switchName - Name of the switch.

number - Number of the agent extension.

Returns:

The object OxeAgentExtensionData.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstance

IInstance getInstance()
               throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOxeSwitchById

OxeSwitchData getOxeSwitchById(int switchId)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of a switch.

Parameters:

switchId - Identifier of the switch.

Returns:

The switchData.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOxeSwitchByName

OxeSwitchData getOxeSwitchByName(String switchName)
                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of a switch.

Parameters:

switchName - Name of the switch.

Returns:

The switchData.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOxeSwitches

OxeSwitchData[] getOxeSwitches()
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Get the list of OXE switches.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOxeSynchroConfiguration

OxeSynchroConfiguration getOxeSynchroConfiguration()
                                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the configuration data of the OxeSynchro application.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOxeSynchroDashboard

OxeSynchroDashboardData getOxeSynchroDashboard(String switchName,
 int dashboardId)
                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of a dashboard entry.

Parameters:

switchName - Name of the OXE switch.

dashboardId - Identifier of the dashboard entry.

Returns:

The dashboard data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOxeSynchroDashboardCursor

IOxeSynchroDashboardCursor getOxeSynchroDashboardCursor(int cursorId)
                                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Gets an OxeSynchro dashboard entry cursor.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IOxeSynchroDashboardCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOxeSynchroDashboardCursors

IOxeSynchroDashboardCursor[] getOxeSynchroDashboardCursors()
                                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the OxeSynchro dashboard entry cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOxeSynchroDashboardTableSchema

TableSchema getOxeSynchroDashboardTableSchema()
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the OxeSynchro dashboard entry.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOxeSynchroProcessTraceConfiguration

ProcessTraceConfiguration getOxeSynchroProcessTraceConfiguration()
                                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the OxeSynchro process trace configuration.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPhoneSetTypesWithAcdLogin

OxePhoneSetType[] getPhoneSetTypesWithAcdLogin()
                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the list of phone set types with "ACD Login" feature.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRoutingPointById

SwitchDeviceData getRoutingPointById(String switchName,
 int id)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the switch device.

Parameters:

switchName - Name of the switch.

id - Identifier of the switch device.

Returns:

The object SwitchDeviceData.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRoutingPointByNumber

SwitchDeviceData getRoutingPointByNumber(String switchName,
 String number)
                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the switch device.

Parameters:

switchName - Name of the switch.

number - Number of the switch device.

Returns:

The object SwitchDeviceData.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newOxeSynchroDashboardCursor

IOxeSynchroDashboardCursor newOxeSynchroDashboardCursor(String switchName,
 String[] columns,
 String sql)
                                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Opens an OxeSynchro dashboard entry cursor.

Parameters:

switchName - Name of the OXE switch.

columns - Columns to fetch.

sql - SQL.

Returns:

The IOxeSynchroDashboardCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetAgentExtensionById

OxeAgentExtensionData tryGetAgentExtensionById(String switchName,
 int id)
                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the agent extension or null if it doesn't exist.

Parameters:

switchName - Name of the switch.

id - Identifier of the agent extension.

Returns:

The object OxeAgentExtensionData.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetAgentExtensionByNumber

OxeAgentExtensionData tryGetAgentExtensionByNumber(String switchName,
 String number)
                                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the agent extension or null if it doesn't exist.

Parameters:

switchName - Name of the switch.

number - Number of the agent extension.

Returns:

The object OxeAgentExtensionData.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetOxeSynchroDashboardCursor

IOxeSynchroDashboardCursor tryGetOxeSynchroDashboardCursor(int cursorId)
                                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets an OxeSynchro dashboard entry cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IOxeSynchroDashboardCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetRoutingPointById

SwitchDeviceData tryGetRoutingPointById(String switchName,
 int id)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the switch device or null if it doesn't exist.

Parameters:

switchName - Name of the switch.

id - Identifier of the switch device.

Returns:

The object SwitchDeviceData.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetRoutingPointByNumber

SwitchDeviceData tryGetRoutingPointByNumber(String switchName,
 String number)
                                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the switch device or null if it doesn't exist.

Parameters:

switchName - Name of the switch.

number - Number of the switch device.

Returns:

The object SwitchDeviceData.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateOxeSwitch

OxeSwitchOperationResult updateOxeSwitch(String switchName,
 OxeSwitchRequest request)
                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a switch.

Parameters:

switchName - Name of the switch.

request - Oxe switch request.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateOxeSynchroDashboard

void updateOxeSynchroDashboard(String switchName,
 int dashboardId,
 OxeSynchroDashboardRequest request)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a dashboard entry.

Parameters:

switchName - Name of the OXE switch.

dashboardId - Identifier of the dashboard entry.

request - Oxe synchro dashboard request

Throws:

Exception

altitude.integrationServer.exceptions.ISException