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

Interface LocationModifier

All Superinterfaces:

IntermediateStorageProvider, Modifier<Location>, UndeletableModifier<Location>

public interface LocationModifier
extends UndeletableModifier<Location>, IntermediateStorageProvider

Since:

10.0.34

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Get the current location description which is held in this LocationModifier.
java.lang.String	getName()	Get the current location name which is held in this LocationModifier.
java.util.TimeZone	getTimeZone()	Get the current location timezone which is held in this LocationModifier.
java.lang.String	getUid()	Get the current location uid which is held in this LocationModifier.
LocationModifier	setDescription(java.lang.String description)	Change the description of the associated Location.
LocationModifier	setName(java.lang.String name)	Change the name of the associated Location.
LocationModifier	setTimeZone(java.lang.String timeZone)	Change the timezone of the associated Location.
LocationModifier	setTimeZone(java.util.TimeZone timeZone)	Change the timezone of the associated Location.
LocationModifier	setUid(java.lang.String uid)	Change the uid of the associated Location.
boolean	validateDescription(java.lang.String description)	Validate the given description.
boolean	validateName(java.lang.String name)	Validate the given name.
boolean	validateTimeZone(java.lang.String timeZone)	Validate the given timezone.
boolean	validateTimeZone(java.util.TimeZone timeZone)	Validate the given timezone.
boolean	validateUid(java.lang.String uid)	Validate the given uid.

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 location name which is held in this LocationModifier.

Returns:

the name as String

Since:

10.0.34

setName

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

Change the name of the associated Location.

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

Parameters:

name - the new name as String

Returns:

the LocationModifier

Throws:

ValidationException - if the new name is invalid

Since:

10.0.34

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

getDescription

java.lang.String getDescription()

Get the current location description which is held in this LocationModifier.

Returns:

the description as String

Since:

10.0.34

setDescription

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

Change the description of the associated Location.

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

Parameters:

description - the new description as String

Returns:

the LocationModifier

Throws:

ValidationException - if the new description is invalid

Since:

10.0.34

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

getUid

java.lang.String getUid()

Get the current location uid which is held in this LocationModifier.

Returns:

the name as String

Since:

10.0.34

setUid

LocationModifier setUid(java.lang.String uid)
                 throws ValidationException

Change the uid of the associated Location.

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

Parameters:

uid - the new uid as String

Returns:

the LocationModifier

Throws:

ValidationException - if the new uid is invalid

Since:

10.0.34

validateUid

boolean validateUid(java.lang.String uid)
             throws ValidationException

Validate the given uid.

Parameters:

uid - the uid to validate as String

Returns:

true if the uid is valid

Throws:

ValidationException - if the uid is invalid

Since:

10.0.34

getTimeZone

java.util.TimeZone getTimeZone()

Get the current location timezone which is held in this LocationModifier.

Returns:

the timezone

Since:

10.0.34

setTimeZone

LocationModifier setTimeZone(java.util.TimeZone timeZone)
                      throws ValidationException

Change the timezone of the associated Location.

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

Parameters:

timeZone - the new timezone

Returns:

the LocationModifier

Throws:

ValidationException - if the new uid is invalid

Since:

10.0.34

validateTimeZone

boolean validateTimeZone(java.util.TimeZone timeZone)
                  throws ValidationException

Validate the given timezone.

Parameters:

timeZone - the timezone to validate

Returns:

true if the timezone is valid

Throws:

ValidationException - if the timezone is invalid

Since:

10.0.34

setTimeZone

LocationModifier setTimeZone(java.lang.String timeZone)
                      throws ValidationException

Change the timezone of the associated Location.

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

Parameters:

timeZone - the new timezone

Returns:

the LocationModifier

Throws:

ValidationException - if the new uid is invalid

Since:

10.0.34

validateTimeZone

boolean validateTimeZone(java.lang.String timeZone)
                  throws ValidationException

Validate the given timezone.

Parameters:

timeZone - the timezone to validate

Returns:

true if the timezone is valid

Throws:

ValidationException - if the timezone is invalid

Since:

10.0.34