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

Interface TransactionCodeModifier

    • 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

      • getDescription

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

      • setDescription

        TransactionCodeModifier setDescription​(java.lang.String description)
                                throws ValidationException

        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

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

      • 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