Package com.novomind.ecom.api.iagent.persistence.storage

Interface StorageHandler

public interface StorageHandler
A Handler for getting a Storage for issues by id and also providing additional information about the available keys of specific StorageProvider interfaces.
Since:
10.0.38

  • Method Details

    • getCallStorage

      Storage getCallStorage(Long id)
      Returns a Storage for a Call with the given id.
      Parameters:
      id - the id of the Call
      Returns:
      the Storage for the Call
      Since:
      13.0

    • getChatStorage

      Storage getChatStorage(Long id)
      Returns a Storage for a Chat with the given id.
      Parameters:
      id - the id of the Chat
      Returns:
      the Storage for the Chat
      Since:
      13.0

    • getTicketStorage

      Storage getTicketStorage(Long id)
      Returns a Storage for a Ticket with the given id.
      Parameters:
      id - the id of the Ticket
      Returns:
      the Storage for the Ticket
      Since:
      10.0.38

    • getCallStorages

      Map<Long,Storage> getCallStorages(Set<Long> callIds)
      Returns a Map of Long -> Storage for the specified Call ids. Please note that the maximum number of returned map entries is limited to 1000 to avoid huge memory consumption.
      Parameters:
      callIds - the set with the Call ids for the desired Call storages
      Returns:
      a Map of Long -> Storage for the given Call ids
      Since:
      13.0

    • getChatStorages

      Map<Long,Storage> getChatStorages(Set<Long> chatIds)
      Returns a Map of Long -> Storage for the specified Chat ids. Please note that the maximum number of returned map entries is limited to 1000 to avoid huge memory consumption.
      Parameters:
      chatIds - the set with the Chat ids for the desired Chat storages
      Returns:
      a Map of Long -> Storage for the given Chat ids
      Since:
      13.0

    • getTicketStorages

      Map<Long,Storage> getTicketStorages(Set<Long> ticketIds)
      Returns a Map of Long -> Storage for the specified Ticket ids. Please note that the maximum number of returned map entries is limited to 1000 to avoid huge memory consumption.
      Parameters:
      ticketIds - the set with the Ticket ids for the desired Ticket storages
      Returns:
      a Map of Long -> Storage for the given Ticket ids
      Since:
      10.0.120

    • getStorageKeyInfos

      <T extends StorageProvider> Set<StorageKeyInfo> getStorageKeyInfos(Class<T> storageProviderClass) throws WrongArgumentException
      This method returns an unmodifiable Set of StorageKeyInfo for the given interface class implementing or extending the StorageProvider interface like Ticket, Call, Chat, Contact, Location, Account, Category, Tenant, TransactionCode, User, App, MessengerAccount, PhoneSystem, ExternalRouting.
      Type Parameters:
      T - the type of the StorageProvider
      Parameters:
      storageProviderClass - the StorageProvider interface class to retrieve the set of StorageKeyInfo for
      Returns:
      a Set of StorageKeyInfo for the given StorageProvider interface
      Throws:
      WrongArgumentException - is thrown if the given StorageProvider interface class is invalid or does not provide a persistent storage (e.g. like Issue)
      Since:
      13.14

    • getStorageKeyInfo

      <T extends StorageProvider> StorageKeyInfo getStorageKeyInfo(Class<T> storageProviderClass, String key) throws WrongArgumentException
      This method returns a StorageKeyInfo for the given key and interface class implementing or extending the StorageProvider interface like Ticket, Call, Chat, Contact, Location, Account, Category, Tenant, TransactionCode, User, App, MessengerAccount, PhoneSystem, ExternalRouting.
      Type Parameters:
      T - the type of the StorageProvider
      Parameters:
      storageProviderClass - the StorageProvider interface class to retrieve the StorageKeyInfo for
      key - the name of the key to retrieve the StorageKeyInfo for
      Returns:
      a StorageKeyInfo for the given StorageProvider interface and the given key
      Throws:
      WrongArgumentException - is thrown if the given StorageProvider interface class is invalid or does not provide a persistent storage (e.g. like Issue) or the given key is invalid or does not exist in the storage
      Since:
      13.14