Interface IInstanceManager

All Superinterfaces:

IDisposable, IEntity

public interface IInstanceManager
extends IEntity

Manages the instance.

Method Summary

Modifier and Type	Method	Description
void	addToBlockedAniList(String ani)	Adds an ANI to the blocked ANI list, i.e.
void	addToDoNotCallList(String doNotCallListName, String number)	Adds a number to the do not call list.
void	addToDoNotCallList(String doNotCallListName, String number, String uniqueId, GregorianCalendar expiryDate)	Adds an entry in the do not call list.
void	cancelBackgroundTask(int taskId)	Cancels the background task.
int	createDayType(DayTypeCreateRequest request)	Creates a day type.
int	createOutcome(int scriptSessionId, Attribute[] outcome)	Creates an outcome.
int	createSite(SiteCreateRequest request)	Creates a site.
int	createTimeZone(TimeZoneCreateRequest request)	Creates a time zone.
void	deleteDayType(String dayTypeName)	Deletes a day type.
void	deleteFromBlockedAniList(String ani)	Deletes an ANI from the blocked ANI list, i.e.
void	deleteFromDoNotCallList(String doNotCallListName, String number)	Deletes a number from the do not call list.
void	deleteFromDoNotCallList(String doNotCallListName, String number, String uniqueId)	Deletes a do not call list entry.
void	deleteOutcome(int outcomeId)	Deletes an outcome.
BackgroundTaskData	getBackgroundTaskData(int taskId)	Gets the background task data.
String[]	getBlockedAniList()	Gets the list of blocked ANIs.
ICubeCursor	getCubeCursor(int cursorId)	Gets a cube cursor open in the instance.
Attribute[][]	getCubeDataAsAttributes(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns)	Fetches data from cubes.
Attribute[][]	getCubeDataAsAttributes(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns, PurposeFilter purposeFilter)	Fetches data from cubes.
String[][]	getCubeDataAsValues(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns)	Fetches data from cubes.
String[][]	getCubeDataAsValues(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns, PurposeFilter purposeFilter)	Fetches data from cubes.
CubeTableSchema	getCubeTableSchema()	Gets the table schema with all existent cube counters.
CubeTableSchema	getCubeTableSchema(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, MediaType mediaType)	Gets the table schema with the counters available for a certain context, specified by the set of cube dimensions, timeframe and media type.
DayType	getDayType(String dayTypeName)	Gets a specific day type.
String[]	getDayTypeNames()	Gets the day type names.
String[]	getDayTypeNamesByDate(GregorianCalendar date)	Gets the day type names that include the given date.
String[]	getDoNotCallListNames()	Gets the list of do not call list names.
EmailGatewayData	getEmailGateway(String gatewayName)	Gets the email gateway data.
EnumeratedType[]	getEnumeratedTypes(int tableSchemaId)	Gets the enumerated types of a table schema.
GatewayData	getGatewayById(GatewayType gatewayType, int gatewayId)	Gets information about the specified gateway.
GatewayData	getGatewayByName(GatewayType gatewayType, String gatewayName)	Gets information about the named gateway.
String[]	getGatewayNames(GatewayType gatewayType)	Gets the list of gateway names.
GatewayData[]	getGateways(GatewayType gatewayType)	Gets the list of gateways.
GatewayState	getGatewayState(GatewayType gatewayType, String gatewayName)	Gets the state of the gateway.
IInstance	getInstance()	The instance.
InstanceData	getInstanceData()	Gets the instance data.
int	getInteractionHistoryCount(String sql)	Gets the count of the interaction history.
IInteractionHistoryCursor	getInteractionHistoryCursor(int cursorId)	Gets a contact profile interaction history cursor open in the instance.
TableSchema	getInteractionHistoryTableSchema()	Gets the table schema of an InteractionThreadScriptSession used in the Fetch of the InteractionHistory cursor.
NotReadyReasonData[]	getNotReadyReasons()	Gets the list of not ready reasons.
RouterAfinitiData	getRouterAfinitiData()	Gets the Router Afiniti data.
IScriptDocumentCursor	getScriptDocumentCursor(int cursorId)	Gets a script document cursor open in the instance.
TableSchema	getScriptDocumentTableSchema()	Gets the table schema of the script document.
TelephonyGatewayData	getTelephonyGateway(String gatewayName)	Gets the telephony gateway data.
boolean	isInBlockedAniList(String ani)	Checks if an ANI is in the blocked ANI list, i.e, checks if an ANI is blocked.
boolean	isInDoNotCallList(String doNotCallListName, String number)	Checks if a number is in the specified, or in the global do not call lists.
boolean	isInDoNotCallList(String doNotCallListName, String number, String uniqueId)	Checks if a number is in the specified, or in the global do not call lists.
ICubeCursor	newCubeCursor(CubeDimensionRequest[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns)	Opens a cube cursor.
ICubeCursor	newCubeCursor(CubeDimensionRequest[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns, PurposeFilter purposeFilter)	Opens a cube cursor.
IInteractionHistoryCursor	newInteractionHistoryCursor(String[] columns, String sql)	Opens an interaction history cursor.
IInteractionHistoryCursor	newInteractionHistoryCursor(String[] columns, String sql, PurposeFilter purposeFilter)	Opens an interaction history cursor.
IScriptDocumentCursor	newScriptDocumentCursor(String[] columns, String sql)	Opens a script document cursor.
void	startGateway(GatewayType gatewayType, String gatewayName)	Starts the gateway.
void	stopGateway(GatewayType gatewayType, String gatewayName)	Stops the gateway.
ICubeCursor	tryGetCubeCursor(int cursorId)	Gets a cube cursor open in the instance or null if it doesn't exist.
IInteractionHistoryCursor	tryGetInteractionHistoryCursor(int cursorId)	Gets a contact profile interaction history cursor open in the instance or null if it doesn't exist.
IScriptDocumentCursor	tryGetScriptDocumentCursor(int cursorId)	Gets a script document cursor open in the instance or null if it doesn't exist.
void	updateDayType(String dayTypeName, DayTypeUpdateRequest request)	Updates a day type.
void	updateInstance(InstanceUpdateRequest request)	Updates the instance.
void	updateOutcome(int outcomeId, Attribute[] outcome)	Updates an outcome.
void	updateRouterAfiniti(RouterAfinitiUpdateRequest request)	Updates the Router Afiniti.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

addToBlockedAniList

void addToBlockedAniList(String ani)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Adds an ANI to the blocked ANI list, i.e. blocks an ANI.

Parameters:

ani - ANI to block.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

addToDoNotCallList

void addToDoNotCallList(String doNotCallListName,
 String number)
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Adds a number to the do not call list.

Parameters:

doNotCallListName - Name of the do not call list.

number - The phone number to add.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

addToDoNotCallList

void addToDoNotCallList(String doNotCallListName,
 String number,
 String uniqueId,
 GregorianCalendar expiryDate)
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Adds an entry in the do not call list.

Parameters:

doNotCallListName - Name of the do not call list.

number - The phone number to add. This parameter is optional.

uniqueId - Unique identifier of the contact profile. This parameter is optional.

expiryDate - Date of the expiration of the do not call list entry. This parameter is optional.

The number and uniqueId parameters can not be both unspecified.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

cancelBackgroundTask

void cancelBackgroundTask(int taskId)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Cancels the background task.

Parameters:

taskId - Identifier of the task.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createDayType

int createDayType(DayTypeCreateRequest request)
           throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a day type.

Parameters:

request - Contains the fields that must be overwritten

Returns:

Identifier of the created day type.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createOutcome

int createOutcome(int scriptSessionId,
 Attribute[] outcome)
           throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Creates an outcome. This is a mechanism designed only to be used in specific situations to correct the outcomes introduced by the agents. Massive use of this functionality is not advised because it may impact severely the performance of the Altitude uCI Server.

Parameters:

scriptSessionId - Identifier of the script session.

outcome - Outcome attributes.

Returns:

Identifier of the created outcome.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

createSite

int createSite(SiteCreateRequest request)
        throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a site.

Parameters:

request - Contains the fields that must be overwritten

Returns:

Identifier of the created site.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createTimeZone

int createTimeZone(TimeZoneCreateRequest request)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a time zone.

Parameters:

request - Contains the fields that must be overwritten

Returns:

Identifier of the created time zone.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteDayType

void deleteDayType(String dayTypeName)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a day type.

Parameters:

dayTypeName - Name of the day type.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteFromBlockedAniList

void deleteFromBlockedAniList(String ani)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes an ANI from the blocked ANI list, i.e. unblocks an ANI.

Parameters:

ani - ANI to unblock.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteFromDoNotCallList

void deleteFromDoNotCallList(String doNotCallListName,
 String number)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a number from the do not call list.

Parameters:

doNotCallListName - Name of the do not call list.

number - The phone number to remove.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteFromDoNotCallList

void deleteFromDoNotCallList(String doNotCallListName,
 String number,
 String uniqueId)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a do not call list entry.

Parameters:

doNotCallListName - Name of the do not call list. This parameter is optional.

number - The phone number to remove. This parameter is optional.

uniqueId - Unique identifier of the contact profile. This parameter is optional.

The number and uniqueId parameters are used to exact match the entries that are deleted. For instance, if number is specified and uniqueId is unspecified, only the entries that have only the number specified are deleted. If number and uniqueId are both unspecified, no entries are deleted.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteOutcome

void deleteOutcome(int outcomeId)
            throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Deletes an outcome. This is a mechanism designed only to be used in specific situations to correct the outcomes introduced by the agents. Massive use of this functionality is not advised because it may impact severely the performance of the Altitude uCI Server.

Parameters:

outcomeId - Identifier of the outcome.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

getBackgroundTaskData

BackgroundTaskData getBackgroundTaskData(int taskId)
                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the background task data.

Parameters:

taskId - Identifier of the task.

Returns:

The object BackgroundTaskData.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getBlockedAniList

String[] getBlockedAniList()
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of blocked ANIs.

Returns:

An array with the ANIs.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCubeCursor

ICubeCursor getCubeCursor(int cursorId)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a cube cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The ICubeCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCubeDataAsAttributes

Attribute[][] getCubeDataAsAttributes(CubeDimensionRequestBase[] dimensionRequests,
 TimeSplitDimension timeSplitDimension,
 GregorianCalendar startMoment,
 GregorianCalendar endMoment,
 Duration startDayTime,
 Duration endDayTime,
 String[] columns)
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Fetches data from cubes.

Parameters:

dimensionRequests - The requests for each dimension.

timeSplitDimension - The time split dimension.

startMoment - The initial moment specified in localtime.

endMoment - The final moment specified in localtime.

startDayTime - The start of the period of the day.

endDayTime - The end of the period of the day.

columns - The columns to fetch. See Types.BuiltInCounter for the columns available.

Returns:

The data fetched.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCubeDataAsAttributes

Attribute[][] getCubeDataAsAttributes(CubeDimensionRequestBase[] dimensionRequests,
 TimeSplitDimension timeSplitDimension,
 GregorianCalendar startMoment,
 GregorianCalendar endMoment,
 Duration startDayTime,
 Duration endDayTime,
 String[] columns,
 PurposeFilter purposeFilter)
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Fetches data from cubes.

Parameters:

dimensionRequests - The requests for each dimension.

timeSplitDimension - The time split dimension.

startMoment - The initial moment specified in localtime.

endMoment - The final moment specified in localtime.

startDayTime - The start of the period of the day.

endDayTime - The end of the period of the day.

columns - The columns to fetch. See Types.BuiltInCounter for the columns available.

purposeFilter - Purpose filter.

Returns:

The data fetched.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCubeDataAsValues

String[][] getCubeDataAsValues(CubeDimensionRequestBase[] dimensionRequests,
 TimeSplitDimension timeSplitDimension,
 GregorianCalendar startMoment,
 GregorianCalendar endMoment,
 Duration startDayTime,
 Duration endDayTime,
 String[] columns)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Fetches data from cubes.

Parameters:

dimensionRequests - The requests for each dimension.

timeSplitDimension - The time split dimension.

startMoment - The initial moment specified in localtime.

endMoment - The final moment specified in localtime.

startDayTime - The start of the period of the day.

endDayTime - The end of the period of the day.

columns - The columns to fetch. See Types.BuiltInCounter for the columns available.

Returns:

The data fetched.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCubeDataAsValues

String[][] getCubeDataAsValues(CubeDimensionRequestBase[] dimensionRequests,
 TimeSplitDimension timeSplitDimension,
 GregorianCalendar startMoment,
 GregorianCalendar endMoment,
 Duration startDayTime,
 Duration endDayTime,
 String[] columns,
 PurposeFilter purposeFilter)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Fetches data from cubes.

Parameters:

dimensionRequests - The requests for each dimension.

timeSplitDimension - The time split dimension.

startMoment - The initial moment specified in localtime.

endMoment - The final moment specified in localtime.

startDayTime - The start of the period of the day.

endDayTime - The end of the period of the day.

columns - The columns to fetch. See Types.BuiltInCounter for the columns available.

purposeFilter - Purpose filter.

Returns:

The data fetched.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCubeTableSchema

CubeTableSchema getCubeTableSchema()
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema with all existent cube counters.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCubeTableSchema

CubeTableSchema getCubeTableSchema(CubeDimensionRequestBase[] dimensionRequests,
 TimeSplitDimension timeSplitDimension,
 MediaType mediaType)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema with the counters available for a certain context, specified by the set of cube dimensions, timeframe and media type. An entity can be fixed (eg: {Campaign-cp0 x BusinessSegment-bs0 x ContactList-all}) by creating a CubeDimensionRequest.EntityIdFilter with the identifier of the entity. eg: cubeDimensionRequest.EntityIdFilter = new int[] {campaign.Id}

Parameters:

dimensionRequests - The requests for each dimension.

timeSplitDimension - The time split dimension.

mediaType - The type of media.

Returns:

The ICubeCursor cursor table schema.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDayType

DayType getDayType(String dayTypeName)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a specific day type.

Parameters:

dayTypeName - Name of the day type.

Returns:

The object DayType.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDayTypeNames

String[] getDayTypeNames()
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the day type names.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDayTypeNamesByDate

String[] getDayTypeNamesByDate(GregorianCalendar date)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the day type names that include the given date.

Parameters:

date - Date to get the day types.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDoNotCallListNames

String[] getDoNotCallListNames()
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of do not call list names.

Returns:

An array with the names of the do not call lists.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEmailGateway

EmailGatewayData getEmailGateway(String gatewayName)
                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the email gateway data.

Parameters:

gatewayName - Name of the gateway.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEnumeratedTypes

EnumeratedType[] getEnumeratedTypes(int tableSchemaId)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the enumerated types of a table schema.

Parameters:

tableSchemaId - Identifier of the table schema.

Returns:

An array with the enumerated types.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getGatewayById

GatewayData getGatewayById(GatewayType gatewayType,
 int gatewayId)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the specified gateway.

Parameters:

gatewayType - Type of gateway.

gatewayId - Id of the gateway.

Returns:

The object GatewayData.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getGatewayByName

GatewayData getGatewayByName(GatewayType gatewayType,
 String gatewayName)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the named gateway.

Parameters:

gatewayType - Type of gateway.

gatewayName - Name of the gateway.

Returns:

The object GatewayData.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getGatewayNames

String[] getGatewayNames(GatewayType gatewayType)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of gateway names.

Parameters:

gatewayType - Type of gateway.

Returns:

An array with the names of the gateways.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getGateways

GatewayData[] getGateways(GatewayType gatewayType)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of gateways.

Parameters:

gatewayType - Type of gateway.

Returns:

An array with the gateways.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getGatewayState

GatewayState getGatewayState(GatewayType gatewayType,
 String gatewayName)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the state of the gateway.

Parameters:

gatewayType - Type of gateway.

gatewayName - Name of the gateway.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstance

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

The instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstanceData

InstanceData getInstanceData()
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the instance data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionHistoryCount

int getInteractionHistoryCount(String sql)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the interaction history.

Parameters:

sql - Sql-like statement. The columns admitted are the ones returned by the GetInteractionHistoryTableSchema method. If null then all rows are counted.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionHistoryCursor

IInteractionHistoryCursor getInteractionHistoryCursor(int cursorId)
                                               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile interaction history cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IInteractionHistoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionHistoryTableSchema

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

Gets the table schema of an InteractionThreadScriptSession used in the Fetch of the InteractionHistory cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getNotReadyReasons

NotReadyReasonData[] getNotReadyReasons()
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of not ready reasons.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRouterAfinitiData

RouterAfinitiData getRouterAfinitiData()
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the Router Afiniti data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getScriptDocumentCursor

IScriptDocumentCursor getScriptDocumentCursor(int cursorId)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a script document cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IScriptDocumentCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getScriptDocumentTableSchema

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

Gets the table schema of the script document.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTelephonyGateway

TelephonyGatewayData getTelephonyGateway(String gatewayName)
                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the telephony gateway data.

Parameters:

gatewayName - Name of the gateway.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

isInBlockedAniList

boolean isInBlockedAniList(String ani)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Checks if an ANI is in the blocked ANI list, i.e, checks if an ANI is blocked.

Parameters:

ani - ANI to check.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

isInDoNotCallList

boolean isInDoNotCallList(String doNotCallListName,
 String number)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Checks if a number is in the specified, or in the global do not call lists.

Parameters:

doNotCallListName - Name of the do not call list.

number - The phone number.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

isInDoNotCallList

boolean isInDoNotCallList(String doNotCallListName,
 String number,
 String uniqueId)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Checks if a number is in the specified, or in the global do not call lists.

Parameters:

doNotCallListName - Name of the do not call list.

number - The phone number. This parameter is optional.

uniqueId - Unique identifier of the contact profile. This parameter is optional.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newCubeCursor

ICubeCursor newCubeCursor(CubeDimensionRequest[] dimensionRequests,
 TimeSplitDimension timeSplitDimension,
 GregorianCalendar startMoment,
 GregorianCalendar endMoment,
 Duration startDayTime,
 Duration endDayTime,
 String[] columns)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Opens a cube cursor.

Parameters:

dimensionRequests - The requests for each dimension.

timeSplitDimension - The time split dimension.

startMoment - The initial moment specified in localtime.

endMoment - The final moment specified in localtime.

startDayTime - The start of the period of the day.

endDayTime - The end of the period of the day.

columns - The columns to fetch. See Types.BuiltInCounter for the columns available.

Returns:

The ICubeCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newCubeCursor

ICubeCursor newCubeCursor(CubeDimensionRequest[] dimensionRequests,
 TimeSplitDimension timeSplitDimension,
 GregorianCalendar startMoment,
 GregorianCalendar endMoment,
 Duration startDayTime,
 Duration endDayTime,
 String[] columns,
 PurposeFilter purposeFilter)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Opens a cube cursor.

Parameters:

dimensionRequests - The requests for each dimension.

timeSplitDimension - The time split dimension.

startMoment - The initial moment specified in localtime.

endMoment - The final moment specified in localtime.

startDayTime - The start of the period of the day.

endDayTime - The end of the period of the day.

columns - The columns to fetch. See Types.BuiltInCounter for the columns available.

purposeFilter - Purpose filter.

Returns:

The ICubeCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newInteractionHistoryCursor

IInteractionHistoryCursor newInteractionHistoryCursor(String[] columns,
 String sql)
                                               throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens an interaction history cursor. The Outcomes field returned by the cursor fetch have null values. Please use the IServiceManager.NewInteractionHistoryCursor method to fetch the outcomes instead.

Parameters:

columns - Columns to fetch.

sql - SQL.

Returns:

The IInteractionHistoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newInteractionHistoryCursor

IInteractionHistoryCursor newInteractionHistoryCursor(String[] columns,
 String sql,
 PurposeFilter purposeFilter)
                                               throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens an interaction history cursor. The Outcomes field returned by the cursor fetch have null values. Please use the IServiceManager.NewInteractionHistoryCursor method to fetch the outcomes instead.

Parameters:

columns - Columns to fetch.

sql - Sql-like statement. The columns admitted are the ones returned by the GetInteractionHistoryTableSchema method. If null then all rows are selected.

purposeFilter - Purpose filter.

Returns:

The IInteractionHistoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newScriptDocumentCursor

IScriptDocumentCursor newScriptDocumentCursor(String[] columns,
 String sql)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a script document cursor. The Outcomes field returned by the cursor fetch have null values.

Parameters:

columns - Columns to fetch.

sql - SQL.

Returns:

The IScriptDocumentCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

startGateway

void startGateway(GatewayType gatewayType,
 String gatewayName)
           throws Exception,
altitude.integrationServer.exceptions.ISException

Starts the gateway.

Parameters:

gatewayType - Type of gateway.

gatewayName - Name of the gateway.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

stopGateway

void stopGateway(GatewayType gatewayType,
 String gatewayName)
          throws Exception,
altitude.integrationServer.exceptions.ISException

Stops the gateway.

Parameters:

gatewayType - Type of gateway.

gatewayName - Name of the gateway.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetCubeCursor

ICubeCursor tryGetCubeCursor(int cursorId)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a cube cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The ICubeCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetInteractionHistoryCursor

IInteractionHistoryCursor tryGetInteractionHistoryCursor(int cursorId)
                                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile interaction history cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IInteractionHistoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetScriptDocumentCursor

IScriptDocumentCursor tryGetScriptDocumentCursor(int cursorId)
                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a script document cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IScriptDocumentCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateDayType

void updateDayType(String dayTypeName,
 DayTypeUpdateRequest request)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a day type.

Parameters:

dayTypeName - Name of the day type.

request - Contains the fields to be updated.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateInstance

void updateInstance(InstanceUpdateRequest request)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Updates the instance.

Parameters:

request - Contains the fields to be updated.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateOutcome

void updateOutcome(int outcomeId,
 Attribute[] outcome)
            throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Updates an outcome. This is a mechanism designed only to be used in specific situations to correct the outcomes introduced by the agents. Massive use of this functionality is not advised because it may impact severely the performance of the Altitude uCI Server.

Parameters:

outcomeId - Identifier of the outcome.

outcome - Outcome attributes.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

updateRouterAfiniti

void updateRouterAfiniti(RouterAfinitiUpdateRequest request)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Updates the Router Afiniti.

Parameters:

request - Contains the fields to be updated.

Throws:

Exception

altitude.integrationServer.exceptions.ISException