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

Interface TenantModifier

All Superinterfaces:

IntermediateStorageProvider, Modifier<Tenant>, UndeletableModifier<Tenant>

public interface TenantModifier
extends UndeletableModifier<Tenant>, IntermediateStorageProvider

Defines an API to modify an instance of type Tenant

Since:

10.0.28

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Get the current tenant description which is held in this TenantModifier.
java.lang.String	getName()	Get the current tenant name which is held in this TenantModifier.
TenantModifier	setDescription(java.lang.String description)	Change the description of the associated Tenant.
TenantModifier	setName(java.lang.String name)	Change the name of the associated Tenant.
boolean	validateDescription(java.lang.String description)	Validate the given description.
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

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

undelete

Method Detail

getName

java.lang.String getName()

Get the current tenant name which is held in this TenantModifier.

Returns:

the name as String

Since:

10.0.28

setName

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

Change the name of the associated Tenant.

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

Parameters:

name - the new name as String

Returns:

the TenantModifier

Throws:

ValidationException - if the new name is invalid

Since:

10.0.28

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:

10.0.28

getDescription

java.lang.String getDescription()

Get the current tenant description which is held in this TenantModifier.

Returns:

the description as String

Since:

10.0.28

setDescription

TenantModifier setDescription(java.lang.String description)
                       throws ValidationException

Change the description of the associated Tenant.

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

Parameters:

description - the new description as String

Returns:

the TenantModifier

Throws:

ValidationException - if the new description is invalid

Since:

10.0.28

validateDescription

boolean validateDescription(java.lang.String description)
                     throws ValidationException

Validate the given description.

Parameters:

description - the description to validate as String

Returns:

true if the description is valid

Throws:

ValidationException - if the description is invalid

Since:

10.0.28