Interface PhoneSystem
-
- All Superinterfaces:
java.lang.Comparable<com.novomind.ecom.common.api.persistence.Entity>
,com.novomind.ecom.common.api.persistence.Entity
,MasterEntity
,com.novomind.ecom.common.api.attribute.Named
,StorageProvider
public interface PhoneSystem extends MasterEntity, com.novomind.ecom.common.api.attribute.Named, StorageProvider
APhoneSystem
provides all required information and configuration for aPhoneSystemConnector
.- Since:
- 11.27
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Set<Tenant>
getAssignedTenants()
Returns an unmodifiable cached view of the assigned tenants.<T extends PhoneSystemConnector>
java.util.Optional<T>getConnector()
Returns the optional instance of thePhoneSystemConnector
.java.lang.String
getType()
The type of aPhoneSystem
is the unmodifiable and unique name of thePhoneSystemConnector
implementation defined by thePhoneSystemConnectorPlugin
annotation of the class.boolean
isEnabled()
Get the current enabled state of thisPhoneSystem
.-
Methods inherited from interface com.novomind.ecom.common.api.persistence.Entity
compareTo, getId, isDeleted, isNotDeleted
-
Methods inherited from interface com.novomind.ecom.api.iagent.provider.StorageProvider
getStorage
-
-
-
-
Method Detail
-
getType
java.lang.String getType()
The type of aPhoneSystem
is the unmodifiable and unique name of thePhoneSystemConnector
implementation defined by thePhoneSystemConnectorPlugin
annotation of the class.- Returns:
- the type of the
PhoneSystem
as string. - Since:
- 11.27
-
isEnabled
boolean isEnabled()
Get the current enabled state of thisPhoneSystem
.- Returns:
- the enabled state as boolean
- Since:
- 11.27
-
getAssignedTenants
java.util.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> java.util.Optional<T> getConnector()
Returns the optional instance of thePhoneSystemConnector
. If thePhoneSystem
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 thePhoneSystemConnector
- Returns:
- the instance of the active
PhoneSystemConnector
or an empty optional if there is currently no active instance. - Since:
- 11.27
-
-