Package com.novomind.ecom.api.iagent.model

Interface PhoneSystem

All Superinterfaces:
Comparable<com.novomind.ecom.common.api.persistence.Entity>, com.novomind.ecom.common.api.persistence.Entity, MasterEntity, com.novomind.ecom.common.api.attribute.Named, StorageProvider, com.novomind.ecom.common.api.persistence.WithId
public interface PhoneSystem extends MasterEntity, com.novomind.ecom.common.api.attribute.Named, StorageProvider
A PhoneSystem provides all required information and configuration for a PhoneSystemConnector.
Since:
11.27

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<Tenant>
    getAssignedTenants()
    Returns an unmodifiable cached view of the assigned tenants.
    <T extends PhoneSystemConnector>
    Optional<T>
    getConnector()
    Returns the optional instance of the PhoneSystemConnector.
    String
    getType()
    The type of a PhoneSystem is the unmodifiable and unique name of the PhoneSystemConnector implementation defined by the PhoneSystemConnectorPlugin annotation of the class.
    boolean
    isEnabled()
    Get the current enabled state of this PhoneSystem.

    Methods inherited from interface com.novomind.ecom.common.api.persistence.Entity

    compareTo, isDeleted, isNotDeleted

    Methods inherited from interface com.novomind.ecom.common.api.attribute.Named

    getName

    Methods inherited from interface com.novomind.ecom.api.iagent.provider.StorageProvider

    getStorage

    Methods inherited from interface com.novomind.ecom.common.api.persistence.WithId

    getId

  • Method Details

    • getType

      String getType()
      The type of a PhoneSystem is the unmodifiable and unique name of the PhoneSystemConnector implementation defined by the PhoneSystemConnectorPlugin annotation of the class.
      Returns:
      the type of the PhoneSystem as string.
      Since:
      11.27

    • isEnabled

      boolean isEnabled()
      Get the current enabled state of this PhoneSystem.
      Returns:
      the enabled state as boolean
      Since:
      11.27

    • getAssignedTenants

      Set<Tenant> getAssignedTenants()
      Returns an unmodifiable cached view of the assigned tenants. The returned set is not updated when assignments change.
      Returns:
      the current assigned tenants as an unmodifiable set
      Since:
      11.27

    • getConnector

      <T extends PhoneSystemConnector> Optional<T> getConnector()
      Returns the optional instance of the PhoneSystemConnector. If the PhoneSystem is not enabled or the plugin class of the given type is not available, the method returns an empty optional.
      Type Parameters:
      T - describes the type of the PhoneSystemConnector
      Returns:
      the instance of the active PhoneSystemConnector or an empty optional if there is currently no active instance.
      Since:
      11.27