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 Details

    • getName

      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(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(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

      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(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(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

      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(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(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

      TimeZone getTimeZone()
      Get the current location timezone which is held in this LocationModifier.
      Returns:
      the timezone
      Since:
      10.0.34

    • setTimeZone

      LocationModifier setTimeZone(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(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(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(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