Interface PhoneSystemModifier
- All Superinterfaces:
IntermediateStorageProvider
,Modifier<PhoneSystem>
Defines an API to modify an instance of type
PhoneSystem
- Since:
- 11.27
-
Method Summary
Modifier and TypeMethodDescriptionaddAssignedTenants
(Tenant... tenants) Assign thePhoneSystem
to the passed tenants.Get an unmodifiable view of the current assigned tenants which are held in thisPhoneSystemModifier
.getName()
Get the current name of the associatedPhoneSystem
which is held in thisPhoneSystemModifier
.boolean
Get the current enabled state which is held in thisPhoneSystemModifier
.removeAssignedTenants
(Tenant... tenants) Remove the assignment of thePhoneSystem
to the passed tenants.setEnabled
(boolean enabled) Change the enabled state of the associatedPhoneSystem
.Change the name of the associatedPhoneSystem
.boolean
validateEnabled
(boolean enabled) Validate the given enabled state.boolean
validateName
(String name) Validate the given name.Methods inherited from interface com.novomind.ecom.api.iagent.provider.IntermediateStorageProvider
getIntermediateStorage
-
Method Details
-
getName
String getName()Get the current name of the associatedPhoneSystem
which is held in thisPhoneSystemModifier
.- Returns:
- the name as String
- Since:
- 11.27
-
setName
Change the name of the associatedPhoneSystem
. The change is applied after theModifier.write()
method is called.- Parameters:
name
- the new name as String- Returns:
- the
PhoneSystemModifier
- Throws:
ValidationException
- if the new name is invalid- Since:
- 11.27
-
validateName
Validate the given name.- Parameters:
name
- the name to validate as String- Returns:
- true if the name is valid
- Throws:
ValidationException
- if the name is invalid- Since:
- 11.27
-
isEnabled
boolean isEnabled()Get the current enabled state which is held in thisPhoneSystemModifier
.- Returns:
- the enabled state as boolean
- Since:
- 11.27
-
setEnabled
Change the enabled state of the associatedPhoneSystem
. The change is applied after theModifier.write()
method is called.- Parameters:
enabled
- the new enabled state as boolean- Returns:
- the
PhoneSystemModifier
- Throws:
ValidationException
- if the new enabled state cannot be applied- Since:
- 11.27
-
validateEnabled
Validate the given enabled state.- Parameters:
enabled
- the new enabled state to be validated- Returns:
- true if the new enabled state can be applied
- Throws:
ValidationException
- if the new enabled state cannot be applied- Since:
- 11.27
-
getAssignedTenants
Get an unmodifiable view of the current assigned tenants which are held in thisPhoneSystemModifier
.- Returns:
- the current assigned tenants as an unmodifiable set
- Since:
- 11.27
-
addAssignedTenants
Assign thePhoneSystem
to the passed tenants. The change is applied after theModifier.write()
method is called.- Parameters:
tenants
- the tenants for which the assignment should be added- Returns:
- the
PhoneSystemModifier
- Throws:
ValidationException
- if a tenant is null or already assigned- Since:
- 11.27
-
removeAssignedTenants
Remove the assignment of thePhoneSystem
to the passed tenants. The change is applied after theModifier.write()
method is called.- Parameters:
tenants
- the tenants for which the assignment should be removed- Returns:
- the
PhoneSystemModifier
- Throws:
ValidationException
- if a tenant is null or not assigned- Since:
- 11.27
-