Interface IServiceManager

All Superinterfaces:
IDisposable, IEntity

public interface IServiceManager extends IEntity
Manages the services.
  • Method Details

    • createFavoriteFilter

      int createFavoriteFilter(String serviceName, FavoriteFilterCreateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException
      Creates a favorite filter.
      Parameters:
      serviceName - Name of the service.
      request - Contains the filter data.
      Returns:
      Identifier of the created filter.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • createService

      int createService(ServiceCreateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException
      Creates a service.
      Parameters:
      request - Contains the fields that must be overwritten
      Returns:
      Identifier of the created service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • createServiceAniList

      int createServiceAniList(String serviceName, ServiceAniListCreateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException
      Creates a service ANI list.
      Parameters:
      serviceName - Name of the service.
      request - Contains the fields that must be overwritten
      Returns:
      Identifier of the created service ANI list.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • createSsmContactDistributionTask

      int createSsmContactDistributionTask(String serviceName, String sql) throws Exception, altitude.integrationServer.exceptions.ISException
      Creates a SSM contact distribution task
      Parameters:
      serviceName - Name of the service.
      sql - SQL.
      Returns:
      Identifier of the created background task.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • deleteFavoriteFilter

      void deleteFavoriteFilter(String serviceName, int filterId) throws Exception, altitude.integrationServer.exceptions.ISException
      Deletes a favorite filter.
      Parameters:
      serviceName - Name of the service.
      filterId - Identifier of the filter
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • deleteService

      void deleteService(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Deletes a service.
      Parameters:
      serviceName - Name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • deleteServiceAniList

      void deleteServiceAniList(String serviceName, String serviceAniListName) throws Exception, altitude.integrationServer.exceptions.ISException
      Deletes a service ANI list.
      Parameters:
      serviceName - Name of the service.
      serviceAniListName - Name of the service ANI list.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getContactUploaderById

      IServiceContactUploader getContactUploaderById(int contactUploaderId) throws Exception, altitude.integrationServer.exceptions.ISException
      Returns a IServiceContactUploader object that previously has started an upload task in the Altitude uCI Server.
      Parameters:
      contactUploaderId - Identifier of the IServiceContactUploader object.
      Returns:
      The IServiceContactUploader object.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getContactUploaderByTaskId

      IServiceContactUploader getContactUploaderByTaskId(int contactUploaderTaskId) throws Exception, altitude.integrationServer.exceptions.ISException
      Returns a IServiceContactUploader object that previously has started an upload task in the Altitude uCI Server.
      Parameters:
      contactUploaderTaskId - Identifier of the entity upload task returned by the IServiceContactUploader.Start
      Returns:
      The IServiceContactUploader object.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getContactUploaders

      IServiceContactUploader[] getContactUploaders() throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the IServiceContactUploader objects.
      Returns:
      The IServiceContactUploader objects.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getCubeDataAsAttributes

      Attribute[][] getCubeDataAsAttributes(String serviceName, 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:
      serviceName - Name of the service.
      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(String serviceName, 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:
      serviceName - Name of the service.
      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(String serviceName, 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:
      serviceName - Name of the service.
      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(String serviceName, 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:
      serviceName - Name of the service.
      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(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the cube schema.
      Parameters:
      serviceName - Name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getEmailGatewayNamesForOutbound

      String[] getEmailGatewayNamesForOutbound(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the names of the email gateways for outbound.
      Parameters:
      serviceName - Name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getFavoriteFilter

      FavoriteFilterData getFavoriteFilter(String serviceName, int filterId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets a favorite filter.
      Parameters:
      serviceName - Name of the service.
      filterId - Identifier of the filter
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getFavoriteFilters

      FavoriteFilterData[] getFavoriteFilters(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets all favorite filters configured for the service.
      Parameters:
      serviceName - Name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getFavoriteFilterTableSchema

      TableSchema getFavoriteFilterTableSchema(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the table schema with the columns that can be used in the service favorite filters.
      Parameters:
      serviceName - Name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getInstance

      IInstance getInstance() throws Exception, altitude.integrationServer.exceptions.ISException
      The instance.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getInteractionHistoryCount

      int getInteractionHistoryCount(String serviceName, String sql) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the count of the interaction history.
      Parameters:
      serviceName - Name of the service.
      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
    • getInteractionHistoryTableSchema

      TableSchema getInteractionHistoryTableSchema(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the table schema of an InteractionThreadScriptSession used in the Fetch of the InteractionHistory cursor.
      Parameters:
      serviceName - Name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getPermissions

      ServiceRolePermission[] getPermissions(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the list of role permissions.
      Parameters:
      serviceName - Name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getServiceAniListById

      ServiceAniListData getServiceAniListById(String serviceName, int serviceAniListId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets a given service ANI list.
      Parameters:
      serviceName - Name of the service.
      serviceAniListId - Code of the service ANI list.
      Returns:
      ServiceAniListData object
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getServiceAniListByName

      ServiceAniListData getServiceAniListByName(String serviceName, String serviceAniListName) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets a given service ANI list.
      Parameters:
      serviceName - Name of the service.
      serviceAniListName - Name of the service ANI list.
      Returns:
      ServiceAniListData object
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getServiceAniLists

      ServiceAniListData[] getServiceAniLists(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets all ANI lists configured for the service.
      Parameters:
      serviceName - Name of the service.
      Returns:
      Array of ServiceAniListData
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getServiceCursor

      IServiceCursor getServiceCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets a service cursor open in the instance.
      Parameters:
      cursorId - Identifier of the cursor.
      Returns:
      The IServiceCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getServiceCursors

      IServiceCursor[] getServiceCursors() throws Exception, altitude.integrationServer.exceptions.ISException
      Returns the service cursors open in the instance.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getServiceDataById

      ServiceData getServiceDataById(int serviceId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the service data.
      Parameters:
      serviceId - Identifier of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getServiceDataByName

      ServiceData getServiceDataByName(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the service data.
      Parameters:
      serviceName - Name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getServiceTableSchema

      TableSchema getServiceTableSchema() throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the table schema of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getState

      ServiceState getState(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the state of the service.
      Parameters:
      serviceName - Name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • newContactUploader

      IServiceContactUploader newContactUploader(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Creates an IServiceContactUploader used to upload contacts.
      Parameters:
      serviceName - Name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • newCubeCursor

      ICubeCursor newCubeCursor(String serviceName, 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:
      serviceName - Name of the service.
      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(String serviceName, 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:
      serviceName - Name of the service.
      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 serviceName, String[] columns, String sql, boolean fetchOutcomes) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException
      Opens an interaction history cursor.
      Parameters:
      serviceName - Name of the service.
      columns - Columns to fetch.
      sql - SQL.
      fetchOutcomes - If true, the outcomes of each interaction are also fetched from the database. If false, the fetched Outcome is null.
      Returns:
      The IInteractionHistoryCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
      altitude.integrationServer.exceptions.ISSqlException
    • newInteractionHistoryCursor

      IInteractionHistoryCursor newInteractionHistoryCursor(String serviceName, String[] columns, String sql, boolean fetchOutcomes, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException
      Opens an interaction history cursor.
      Parameters:
      serviceName - Name of the service.
      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.
      fetchOutcomes - If true, the outcomes of each interaction are also fetched from the database. If false, the fetched Outcome is null.
      purposeFilter - Purpose filter.
      Returns:
      The IInteractionHistoryCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
      altitude.integrationServer.exceptions.ISSqlException
    • newServiceCursor

      IServiceCursor newServiceCursor(String[] columns, String sql) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException
      Opens a service cursor.
      Parameters:
      columns - Columns to fetch.
      sql - SQL.
      Returns:
      The IServiceCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
      altitude.integrationServer.exceptions.ISSqlException
    • start

      void start(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Starts the service.
      Parameters:
      serviceName - Name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • stop

      void stop(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Stops the service.
      Parameters:
      serviceName - Name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • suspend

      void suspend(String serviceName) throws Exception, altitude.integrationServer.exceptions.ISException
      Suspends the service.
      Parameters:
      serviceName - Name of the service.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • tryGetServiceCursor

      IServiceCursor tryGetServiceCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets a service cursor open in the instance or null if it doesn't exist.
      Parameters:
      cursorId - Identifier of the cursor.
      Returns:
      The IServiceCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • updateFavoriteFilter

      void updateFavoriteFilter(String serviceName, int filterId, FavoriteFilterUpdateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException
      Updates a favorite filter.
      Parameters:
      serviceName - Name of the service.
      filterId - Identifier of the filter
      request - Contains the filter data to update.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • updateService

      void updateService(String serviceName, ServiceUpdateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException
      Updates a service.
      Parameters:
      serviceName - Name of the service.
      request - Describes what to update.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • updateServiceAniList

      void updateServiceAniList(String serviceName, String serviceAniListName, ServiceAniListUpdateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException
      Updates a service ANI list.
      Parameters:
      serviceName - Name of the service.
      serviceAniListName - Name of the service ANI list.
      request - Contains the fields to be updated.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException