Package com.novomind.ecom.api.imail.routing.persistence

Interface ExternalRoutingModifier

All Superinterfaces:

IntermediateStorageProvider, Modifier<ExternalRouting>

public interface ExternalRoutingModifier
extends Modifier<ExternalRouting>, IntermediateStorageProvider

Defines an API to modify an instance of type ExternalRouting

Since:

11.29

Method Summary

Modifier and Type	Method	Description
ExternalRoutingModifier	addAssignedTenants(Tenant... tenants)	Assign the ExternalRouting to the passed tenants.
java.util.Set<Tenant>	getAssignedTenants()	Get an unmodifiable view of the current assigned tenants which are held in this ExternalRoutingModifier.
java.lang.String	getName()	Get the current name of the associated ExternalRouting which is held in this ExternalRoutingModifier.
boolean	isEnabled()	Get the current enabled state which is held in this ExternalRoutingModifier.
ExternalRoutingModifier	removeAssignedTenants(Tenant... tenants)	Remove the assignment of the ExternalRouting to the passed tenants.
ExternalRoutingModifier	setEnabled(boolean enabled)	Change the enabled state of the associated ExternalRouting.
ExternalRoutingModifier	setName(java.lang.String name)	Change the name of the associated ExternalRouting.
boolean	validateEnabled(boolean enabled)	Validate the given enabled state.
boolean	validateName(java.lang.String name)	Validate the given name.

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

getIntermediateStorage

Methods inherited from interface com.novomind.ecom.api.imail.routing.persistence.Modifier

delete, get, write

Method Detail

getName

java.lang.String getName()

Get the current name of the associated ExternalRouting which is held in this ExternalRoutingModifier.

Returns:

the name as String

Since:

11.29

setName

ExternalRoutingModifier setName(java.lang.String name)
                         throws ValidationException

Change the name of the associated ExternalRouting.

The change is applied after the Modifier.write() method is called.

Parameters:

name - the new name as String

Returns:

the ExternalRoutingModifier

Throws:

ValidationException - if the new name is invalid

Since:

11.29

validateName

boolean validateName(java.lang.String name)
              throws ValidationException

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.29

isEnabled

boolean isEnabled()

Get the current enabled state which is held in this ExternalRoutingModifier.

Returns:

the enabled state as boolean

Since:

11.29

setEnabled

ExternalRoutingModifier setEnabled(boolean enabled)
                            throws ValidationException

Change the enabled state of the associated ExternalRouting.

The change is applied after the Modifier.write() method is called.

Parameters:

enabled - the new enabled state as boolean

Returns:

the ExternalRoutingModifier

Throws:

ValidationException - if the new enabled state cannot be applied

Since:

11.29

validateEnabled

boolean validateEnabled(boolean enabled)
                 throws ValidationException

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.29

getAssignedTenants

java.util.Set<Tenant> getAssignedTenants()

Get an unmodifiable view of the current assigned tenants which are held in this ExternalRoutingModifier.

Returns:

the current assigned tenants as an unmodifiable set

Since:

11.29

addAssignedTenants

ExternalRoutingModifier addAssignedTenants(Tenant... tenants)
                                    throws ValidationException

Assign the ExternalRouting to the passed tenants.

The change is applied after the Modifier.write() method is called.

Parameters:

tenants - the tenants the ExternalRouting should be assigned to

Returns:

the ExternalRoutingModifier

Throws:

ValidationException - if a tenant is null or already assigned

Since:

11.29

removeAssignedTenants

ExternalRoutingModifier removeAssignedTenants(Tenant... tenants)
                                       throws ValidationException

Remove the assignment of the ExternalRouting to the passed tenants.

The change is applied after the Modifier.write() method is called.

Parameters:

tenants - the tenants for which the assignment should be removed

Returns:

the ExternalRoutingModifier

Throws:

ValidationException - if a tenant is null or not assigned

Since:

11.29