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

Interface TransactionCodeModifier

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      TransactionCodeModifier addAssignedCategories​(Category... categories)
      Assign the transaction code to the passed categories.
      java.util.Set<Category> getAssignedCategories()
      Get an unmodifiable view of the current assigned categories which are held in this TransactionCodeModifier.
      java.lang.String getDescription()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Replaced by getDescription(Locale)} This method will now return the localized description of the associated TransactionCode for the default language of the novomind iAGENT system.
      java.lang.String getDescription​(java.util.Locale locale)
      Get the current transaction code description for the provided language which is held in this TransactionCodeModifier.
      java.lang.String getDisplayName​(java.util.Locale locale)
      Get the current transaction code display name for the provided language which is held in this TransactionCodeModifier.
      IntermediateStorage getIntermediateStorage()
      Returns the IntermediateStorage for the instance of this AccountModifier
      java.lang.String getName()
      Get the current transaction code name which is held in this TransactionCodeModifier.
      TransactionCodeModifier removeAssignedCategories​(Category... categories)
      Remove the assignment of the transaction code to the passed categories.
      TransactionCodeModifier setDescription​(java.lang.String description)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Replaced by setDescription(Locale, String)} This method will now set the localized description of the associated TransactionCode for the default language of the novomind iAGENT system.
      TransactionCodeModifier setDescription​(java.util.Locale locale, java.lang.String description)
      Change the description for the provided language of the associated TransactionCode.
      TransactionCodeModifier setDisplayName​(java.util.Locale locale, java.lang.String displayName)
      Change the display name for the provided language of the associated TransactionCode.
      TransactionCodeModifier setName​(java.lang.String name)
      Change the name of the associated TransactionCode.
      boolean validateDescription​(java.lang.String description)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Replaced by validateDescription(Locale, String)} This method will now validate the localized description of the associated TransactionCode for the default language of the novomind iAGENT system.
      boolean validateDescription​(java.util.Locale locale, java.lang.String description)
      Validate the given description for the provided language.
      boolean validateDisplayName​(java.util.Locale locale, java.lang.String displayName)
      Validate the given display name for the provided language.
      boolean validateName​(java.lang.String name)
      Validate the given name.

    • Method Detail

      • getName

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

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

      • getDisplayName

        java.lang.String getDisplayName​(java.util.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​(java.util.Locale locale,
                                       java.lang.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​(java.util.Locale locale,
                            java.lang.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

        @Deprecated(since="12.31",
            forRemoval=true)
java.lang.String getDescription()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Replaced by getDescription(Locale)} This method will now return the localized description of the associated TransactionCode for the default language of the novomind iAGENT system.
        Get the current transaction code description which is held in this TransactionCodeModifier.
        Returns:
        the description as String
        Since:
        10.0.38

      • getDescription

        java.lang.String getDescription​(java.util.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

        @Deprecated(since="12.31",
            forRemoval=true)
TransactionCodeModifier setDescription​(java.lang.String description)
                                throws ValidationException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Replaced by setDescription(Locale, String)} This method will now set the localized description of the associated TransactionCode for the default language of the novomind iAGENT system.

        Change the description of the associated TransactionCode.

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

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

      • setDescription

        TransactionCodeModifier setDescription​(java.util.Locale locale,
                                       java.lang.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

        @Deprecated(since="12.31",
            forRemoval=true)
boolean validateDescription​(java.lang.String description)
                     throws ValidationException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Replaced by validateDescription(Locale, String)} This method will now validate the localized description of the associated TransactionCode for the default language of the novomind iAGENT system.
        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.38

      • validateDescription

        boolean validateDescription​(java.util.Locale locale,
                            java.lang.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

        java.util.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