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

Interface TransactionCodeModifier

All Superinterfaces:
IntermediateStorageProvider, Modifier<TransactionCode>, UndeletableModifier<TransactionCode>
public interface TransactionCodeModifier extends UndeletableModifier<TransactionCode>, IntermediateStorageProvider
Defines an API to modify an instance of type TransactionCode
Since:
10.0.38

  • Method Details

    • getName

      String getName()
      Get the current transaction code name which is held in this TransactionCodeModifier.
      Returns:
      the name as String
      Since:
      10.0.38

    • setName

      TransactionCodeModifier setName(String name) throws ValidationException

      Change the name of the associated TransactionCode.

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

      Parameters:
      name - the new name as String
      Returns:
      the TransactionCodeModifier
      Throws:
      ValidationException - if the new name is invalid
      Since:
      10.0.38

    • 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.38

    • getDisplayName

      String getDisplayName(Locale locale)
      Get the current transaction code display name for the provided language which is held in this TransactionCodeModifier. If the specified language is null or not supported the configured default language of the novomind iAGENT system will be used instead. Please note that only the language attribute of the given Locale is used.
      Parameters:
      locale - the locale with the language used to localize the display name of this object or null
      Returns:
      the display name for the provided language as String
      Since:
      12.31

    • setDisplayName

      TransactionCodeModifier setDisplayName(Locale locale, String displayName) throws ValidationException

      Change the display name for the provided language of the associated TransactionCode.

      If the specified language is null the configured default language of the novomind iAGENT system will be used instead. A ValidationException will be thrown if the specified language is not supported. Please note that only the language attribute of the given Locale is used.

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

      Parameters:
      locale - the locale with the language for which the display name should be changed or null
      displayName - the new display name for the provided language as String
      Returns:
      the TransactionCodeModifier
      Throws:
      ValidationException - if the language or the new display name are invalid
      Since:
      12.31

    • validateDisplayName

      boolean validateDisplayName(Locale locale, String displayName) throws ValidationException
      Validate the given display name for the provided language. If the specified language is null the configured default language of the novomind iAGENT system will be used instead. A ValidationException will be thrown if the specified language is not supported. Please note that only the language attribute of the given Locale is used.
      Parameters:
      locale - the locale with the language to validate or null
      displayName - the display name to validate as String
      Returns:
      true if the display name is valid
      Throws:
      ValidationException - if the language or the display name are invalid
      Since:
      12.31

    • getDescription

      String getDescription(Locale locale)
      Get the current transaction code description for the provided language which is held in this TransactionCodeModifier. If the specified language is null or not supported the configured default language of the novomind iAGENT system will be used instead. Please note that only the language attribute of the given Locale is used.
      Parameters:
      locale - the locale with the language used to localize the description of this object or null
      Returns:
      the display name for the provided language as String
      Since:
      12.31

    • setDescription

      TransactionCodeModifier setDescription(Locale locale, String description) throws ValidationException

      Change the description for the provided language of the associated TransactionCode.

      If the specified language is null the configured default language of the novomind iAGENT system will be used instead. A ValidationException will be thrown if the specified language is not supported. Please note that only the language attribute of the given Locale is used.

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

      Parameters:
      locale - the locale with the language for which the description should be changed or null
      description - the new description for the provided language as String
      Returns:
      the TransactionCodeModifier
      Throws:
      ValidationException - if the language or the new description are invalid
      Since:
      12.31

    • validateDescription

      boolean validateDescription(Locale locale, String description) throws ValidationException
      Validate the given description for the provided language. If the specified language is null the configured default language of the novomind iAGENT system will be used instead. A ValidationException will be thrown if the specified language is not supported. Please note that only the language attribute of the given Locale is used.
      Parameters:
      locale - the locale with the language to validate or null
      description - the description to validate as String
      Returns:
      true if the description is valid
      Throws:
      ValidationException - if the language or the description are invalid
      Since:
      12.31

    • getAssignedCategories

      Set<Category> getAssignedCategories()
      Get an unmodifiable view of the current assigned categories which are held in this TransactionCodeModifier.
      Returns:
      the current assigned categories as an unmodifiable set
      Since:
      10.0.38

    • addAssignedCategories

      TransactionCodeModifier addAssignedCategories(Category... categories) throws ValidationException

      Assign the transaction code to the passed categories.

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

      Parameters:
      categories - the categories the transaction code should be assigned to
      Returns:
      the TransactionCodeModifier
      Throws:
      ValidationException - if a category is null or already assigned
      Since:
      10.0.38

    • removeAssignedCategories

      TransactionCodeModifier removeAssignedCategories(Category... categories) throws ValidationException

      Remove the assignment of the transaction code to the passed categories.

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

      Parameters:
      categories - the categories for which the assignment should be removed
      Returns:
      the TransactionCodeModifier
      Throws:
      ValidationException - if a category is null or not assigned
      Since:
      10.0.38

    • getIntermediateStorage

      IntermediateStorage getIntermediateStorage() throws PersistencyException
      Description copied from interface: IntermediateStorageProvider
      Returns the IntermediateStorage for the instance of this AccountModifier
      Specified by:
      getIntermediateStorage in interface IntermediateStorageProvider
      Returns:
      the IntermediateStorage
      Throws:
      PersistencyException - is thrown if an error occurs during the initialization of the Storage
      Since:
      11.14