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

Interface CategoryModifier

    • Method Detail

      • getDisplayName

        java.lang.String getDisplayName()
        Get the current category display name which is held in this CategoryModifier.
        Returns:
        the name as String
        Since:
        10.0.50

      • setDisplayName

        CategoryModifier setDisplayName​(java.lang.String displayName)
                         throws ValidationException

        Change the display name of the associated Category.

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

        Parameters:
        displayName - the new display name as String
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the new display name is invalid
        Since:
        10.0.50

      • validateDisplayName

        boolean validateDisplayName​(java.lang.String displayName)
                     throws ValidationException
        Validate the given display name.
        Parameters:
        displayName - the display name to validate as String
        Returns:
        true if the display name is valid
        Throws:
        ValidationException - if the display name is invalid
        Since:
        10.0.50

      • getDescription

        java.lang.String getDescription()
        Get the current category description which is held in this CategoryModifier.
        Returns:
        the description as String
        Since:
        10.0.50

      • setDescription

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

        Change the description of the associated Category.

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

        Parameters:
        description - the new description as String
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the new description is invalid
        Since:
        10.0.50

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

      • getAssignedTransactionCodes

        java.util.Set<TransactionCode> getAssignedTransactionCodes()
        Get an unmodifiable view of the current assigned transaction codes which are held in this CategoryModifier.
        Returns:
        the current assigned transaction codes as an unmodifiable set
        Since:
        10.0.50

      • addAssignedTransactionCodes

        CategoryModifier addAssignedTransactionCodes​(TransactionCode... transactionCodes)
                                      throws ValidationException

        Assign the category to the passed transaction codes.

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

        Parameters:
        transactionCodes - the transaction codes the category should be assigned to
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if a transaction code is null or already assigned
        Since:
        10.0.50

      • removeAssignedTransactionCodes

        CategoryModifier removeAssignedTransactionCodes​(TransactionCode... transactionCodes)
                                         throws ValidationException

        Remove the assignment of the category to the passed transaction codes.

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

        Parameters:
        transactionCodes - the transaction codes for which the assignment should be removed
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if a transaction code is null or not assigned
        Since:
        10.0.50

      • getAssignedTextModuleFirstLevelGroups

        java.util.Set<TextModuleFirstLevelGroup> getAssignedTextModuleFirstLevelGroups()
        Get an unmodifiable view of the current assigned text module first level groups which are held in this CategoryModifier.
        Returns:
        the current assigned text module first level groups as an unmodifiable set
        Since:
        10.0.206

      • addAssignedTextModuleFirstLevelGroups

        CategoryModifier addAssignedTextModuleFirstLevelGroups​(TextModuleFirstLevelGroup... textModuleFirstLevelGroups)
                                                throws ValidationException

        Assign the category to the passed text module first level groups.

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

        Parameters:
        textModuleFirstLevelGroups - the text module first level groups the category should be assigned to
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if a text module first level group is null or already assigned
        Since:
        10.0.206

      • removeAssignedTextModuleFirstLevelGroups

        CategoryModifier removeAssignedTextModuleFirstLevelGroups​(TextModuleFirstLevelGroup... textModuleFirstLevelGroups)
                                                   throws ValidationException

        Remove the assignment of the category to the passed text module first level groups.

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

        Parameters:
        textModuleFirstLevelGroups - the text module first level groups for which the assignment should be removed
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if a text module first level group is null or not assigned
        Since:
        10.0.206

      • getAssignedAgentGroup

        AgentGroup getAssignedAgentGroup()
        Get the current assigned AgentGroup which is held in this CategoryModifier.
        Returns:
        the current assigned AgentGroup
        Since:
        10.0.50

      • validateAssignedAgentGroup

        boolean validateAssignedAgentGroup​(AgentGroup agentGroup)
                            throws ValidationException
        Validate the given AgentGroup.
        Parameters:
        agentGroup - the agent group to validate
        Returns:
        true if the agent group is valid
        Throws:
        ValidationException - if the agent group is invalid
        Since:
        10.0.50

      • getAssignedSystemGroups

        java.util.Set<SystemGroup> getAssignedSystemGroups()
        Get an unmodifiable view of the current assigned system groups which are held in this CategoryModifier.
        Returns:
        the current assigned system groups as an unmodifiable set
        Since:
        10.0.108

      • addAssignedSystemGroups

        CategoryModifier addAssignedSystemGroups​(SystemGroup... systemGroups)
                                  throws ValidationException

        Assign the category to the passed system groups.

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

        Parameters:
        systemGroups - the system groups the category should be assigned to
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if a system group is null or already assigned
        Since:
        10.0.108

      • removeAssignedSystemGroups

        CategoryModifier removeAssignedSystemGroups​(SystemGroup... systemGroups)
                                     throws ValidationException

        Remove the assignment of the category to the passed system groups.

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

        Parameters:
        systemGroups - the system groups for which the assignment should be removed
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if a system group is null or not assigned
        Since:
        10.0.108

      • getEscalationCategory

        Category getEscalationCategory()
        Get the current escalation category which is held in this CategoryModifier.
        Returns:
        the category used for escalation
        Since:
        10.0.50

      • setEscalationCategory

        CategoryModifier setEscalationCategory​(Category escalationCategory)
                                throws ValidationException

        Change the escalation category.

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

        Parameters:
        escalationCategory - the new escalation category
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the new escalation category is invalid
        Since:
        10.0.50

      • validateEscalationCategory

        boolean validateEscalationCategory​(Category escalationCategory)
                            throws ValidationException
        Validate the given escalation category.
        Parameters:
        escalationCategory - the escalation category to validate
        Returns:
        true if the escalation category is valid
        Throws:
        ValidationException - if the escalation category is invalid
        Since:
        10.0.50

      • getEscalationTimeoutMillis

        java.lang.Long getEscalationTimeoutMillis()
        Get the current escalation timeout in milliseconds which is held in this CategoryModifier.
        Returns:
        the escalation timeout in milliseconds
        Since:
        10.0.50

      • setEscalationTimeoutMillis

        CategoryModifier setEscalationTimeoutMillis​(java.lang.Long escalationTimeoutMillis)
                                     throws ValidationException

        Change the escalation timeout.

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

        Parameters:
        escalationTimeoutMillis - the new escalation timeout in milliseconds
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the new escalation timeout is invalid
        Since:
        10.0.50

      • validateEscalationTimeoutMillis

        boolean validateEscalationTimeoutMillis​(java.lang.Long escalationTimeoutMillis)
                                 throws ValidationException
        Validate the given escalation timeout.
        Parameters:
        escalationTimeoutMillis - the escalation timeout in milliseconds to validate
        Returns:
        true if the escalation timeout is valid
        Throws:
        ValidationException - if the escalation timeout is invalid
        Since:
        10.0.50

      • getServiceLevelMillis

        java.lang.Long getServiceLevelMillis()
        Get the current service level in milliseconds which is held in this CategoryModifier.
        Returns:
        the configured service level for this category in milliseconds
        Since:
        10.0.50

      • setServiceLevelMillis

        CategoryModifier setServiceLevelMillis​(java.lang.Long serviceLevelMillis)
                                throws ValidationException

        Change the service level.

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

        Parameters:
        serviceLevelMillis - the new service level in milliseconds
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the new service level is invalid
        Since:
        10.0.50

      • validateServiceLevelMillis

        boolean validateServiceLevelMillis​(java.lang.Long serviceLevelMillis)
                            throws ValidationException
        Validate the given service level.
        Parameters:
        serviceLevelMillis - the service level in milliseconds to validate
        Returns:
        true if the service level is valid
        Throws:
        ValidationException - if the service level is invalid
        Since:
        10.0.50

      • isAutoRoutingEnabled

        boolean isAutoRoutingEnabled()
        Get the current automatic routing state which is held in this CategoryModifier.
        Returns:
        true if automatic routing is enabled, otherwise false
        Since:
        10.0.50

      • setAutoRoutingEnabled

        CategoryModifier setAutoRoutingEnabled​(boolean autoRoutingEnabled)
                                throws ValidationException

        Change the automatic routing state.

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

        Parameters:
        autoRoutingEnabled - the new automatic routing state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validateAutoRoutingEnabled

        boolean validateAutoRoutingEnabled​(boolean autoRoutingEnabled)
                            throws ValidationException
        Validate the given automatic routing state.
        Parameters:
        autoRoutingEnabled - the new automatic routing state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • isPrivilegedRoutingEnabled

        boolean isPrivilegedRoutingEnabled()
        Get the current privileged routing state which is held in this CategoryModifier.
        Returns:
        true if privileged routing is enabled, otherwise false
        Since:
        10.0.50

      • setPrivilegedRoutingEnabled

        CategoryModifier setPrivilegedRoutingEnabled​(boolean privilegedRoutingEnabled)
                                      throws ValidationException

        Change the privileged routing state.

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

        Parameters:
        privilegedRoutingEnabled - the new privileged routing state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validatePrivilegedRoutingEnabled

        boolean validatePrivilegedRoutingEnabled​(boolean privilegedRoutingEnabled)
                                  throws ValidationException
        Validate the given privileged routing state.
        Parameters:
        privilegedRoutingEnabled - the new privileged routing state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • isCtiRoutingEnabled

        boolean isCtiRoutingEnabled()
        Get the current cti routing state which is held in this CategoryModifier.
        Returns:
        true if cti routing is enabled, otherwise false
        Since:
        10.0.50

      • setCtiRoutingEnabled

        CategoryModifier setCtiRoutingEnabled​(boolean ctiRoutingEnabled)
                               throws ValidationException

        Change the cti routing state.

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

        Parameters:
        ctiRoutingEnabled - the new cti routing state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validateCtiRoutingEnabled

        boolean validateCtiRoutingEnabled​(boolean ctiRoutingEnabled)
                           throws ValidationException
        Validate the given cti routing state.
        Parameters:
        ctiRoutingEnabled - the new cti routing state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • isBundlingEnabled

        boolean isBundlingEnabled()
        Get the current bundling state which is held in this CategoryModifier.
        Returns:
        true if bundling is enabled, otherwise false
        Since:
        10.0.50

      • setBundlingEnabled

        CategoryModifier setBundlingEnabled​(boolean bundlingEnabled)
                             throws ValidationException

        Change the bundling state.

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

        Parameters:
        bundlingEnabled - the new bundling state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validateBundlingEnabled

        boolean validateBundlingEnabled​(boolean bundlingEnabled)
                         throws ValidationException
        Validate the given bundling state.
        Parameters:
        bundlingEnabled - the new bundling state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • isAnswerAllowed

        boolean isAnswerAllowed()
        Get the current answer allowed state which is held in this CategoryModifier.
        Returns:
        true if it is allowed to answer tickets in this category, otherwise false
        Since:
        10.0.50

      • setAnswerAllowed

        CategoryModifier setAnswerAllowed​(boolean answerAllowed)
                           throws ValidationException

        Change the answer allowed state.

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

        Parameters:
        answerAllowed - the new answer allowed state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validateAnswerAllowed

        boolean validateAnswerAllowed​(boolean answerAllowed)
                       throws ValidationException
        Validate the given answer allowed state.
        Parameters:
        answerAllowed - the new answer allowed state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • isCloseAllowed

        boolean isCloseAllowed()
        Get the current close allowed state which is held in this CategoryModifier.
        Returns:
        true if it is allowed to close tickets in this category, otherwise false
        Since:
        10.0.50

      • setCloseAllowed

        CategoryModifier setCloseAllowed​(boolean closeAllowed)
                          throws ValidationException

        Change the close allowed state.

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

        Parameters:
        closeAllowed - the new close allowed state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validateCloseAllowed

        boolean validateCloseAllowed​(boolean closeAllowed)
                      throws ValidationException
        Validate the given close allowed state.
        Parameters:
        closeAllowed - the new close allowed state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • isTransactionCodeRequired

        boolean isTransactionCodeRequired()
        Get the current transaction code required state which is held in this CategoryModifier.
        Returns:
        true if it is required to specify a TransactionCode to close a ticket in this category, otherwise false
        Since:
        10.0.50

      • setTransactionCodeRequired

        CategoryModifier setTransactionCodeRequired​(boolean transactionCodeRequired)
                                     throws ValidationException

        Change the transaction code required state.

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

        Parameters:
        transactionCodeRequired - the new transaction code required state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validateTransactionCodeRequired

        boolean validateTransactionCodeRequired​(boolean transactionCodeRequired)
                                 throws ValidationException
        Validate the given transaction code required state.
        Parameters:
        transactionCodeRequired - the new transaction code required state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • isClearanceRequired

        boolean isClearanceRequired()
        Get the current clearance required state which is held in this CategoryModifier.
        Returns:
        true if a clearance is required, otherwise false
        Since:
        10.0.50

      • setClearanceRequired

        CategoryModifier setClearanceRequired​(boolean clearanceRequired)
                               throws ValidationException

        Change the clearance required state.

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

        Parameters:
        clearanceRequired - the new clearance required state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validateClearanceRequired

        boolean validateClearanceRequired​(boolean clearanceRequired)
                           throws ValidationException
        Validate the given clearance required state.
        Parameters:
        clearanceRequired - the new clearance required state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • isSpellcheckRequired

        boolean isSpellcheckRequired()
        Get the current spellcheck required state which is held in this CategoryModifier.
        Returns:
        true if spellcheck is required, otherwise false
        Since:
        10.0.50

      • setSpellcheckRequired

        CategoryModifier setSpellcheckRequired​(boolean spellcheckRequired)
                                throws ValidationException

        Change the spellcheck required state.

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

        Parameters:
        spellcheckRequired - the new spellcheck required state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validateSpellcheckRequired

        boolean validateSpellcheckRequired​(boolean spellcheckRequired)
                            throws ValidationException
        Validate the given spellcheck required state.
        Parameters:
        spellcheckRequired - the new spellcheck required state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • isChatCategory

        boolean isChatCategory()
        Get the current chat category state which is held in this CategoryModifier.
        Returns:
        true if chats are allowed in this category, otherwise false
        Since:
        10.0.50

      • setChatCategory

        CategoryModifier setChatCategory​(boolean chatCategory)
                          throws ValidationException

        Change the chat category state.

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

        Parameters:
        chatCategory - the new chat category state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validateChatCategory

        boolean validateChatCategory​(boolean chatCategory)
                      throws ValidationException
        Validate the given chat category state.
        Parameters:
        chatCategory - the new chat category state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • isAllowedRecategorizationSource

        boolean isAllowedRecategorizationSource()
        Get the current allowed recategorization source state which is held in this CategoryModifier.
        Returns:
        true if this category is an allowed source for recategorizations, otherwise false
        Since:
        10.0.50

      • setAllowedRecategorizationSource

        CategoryModifier setAllowedRecategorizationSource​(boolean allowedRecategorizationSource)
                                           throws ValidationException

        Change the allowed recategorization source state.

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

        Parameters:
        allowedRecategorizationSource - the new allowed recategorization source state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validateAllowedRecategorizationSource

        boolean validateAllowedRecategorizationSource​(boolean allowedRecategorizationSource)
                                       throws ValidationException
        Validate the given allowed recategorization source state.
        Parameters:
        allowedRecategorizationSource - the new allowed recategorization source state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • isAllowedRecategorizationDestination

        boolean isAllowedRecategorizationDestination()
        Get the current allowed recategorization destination state which is held in this CategoryModifier.
        Returns:
        true if this category is an allowed destination for recategorizations, otherwise false
        Since:
        10.0.50

      • setAllowedRecategorizationDestination

        CategoryModifier setAllowedRecategorizationDestination​(boolean allowedRecategorizationDestination)
                                                throws ValidationException

        Change the allowed recategorization destination state.

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

        Parameters:
        allowedRecategorizationDestination - the new allowed recategorization destination state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validateAllowedRecategorizationDestination

        boolean validateAllowedRecategorizationDestination​(boolean allowedRecategorizationDestination)
                                            throws ValidationException
        Validate the given allowed recategorization destination state.
        Parameters:
        allowedRecategorizationDestination - the new allowed recategorization destination state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • isAllowedForPhoneTickets

        boolean isAllowedForPhoneTickets()
        Get the current allowed for phone tickets state which is held in this CategoryModifier.
        Returns:
        true if this category is allowed for phone tickets
        Since:
        10.0.50

      • setAllowedForPhoneTickets

        CategoryModifier setAllowedForPhoneTickets​(boolean allowedForPhoneTickets)
                                    throws ValidationException

        Change the allowed for phone tickets state.

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

        Parameters:
        allowedForPhoneTickets - the new allowed for phone tickets state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validateAllowedForPhoneTickets

        boolean validateAllowedForPhoneTickets​(boolean allowedForPhoneTickets)
                                throws ValidationException
        Validate the given allowed for phone tickets state.
        Parameters:
        allowedForPhoneTickets - the new allowed for phone tickets state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • isAllowedForNewProcesses

        boolean isAllowedForNewProcesses()
        Get the current allowed for new processes state which is held in this CategoryModifier.
        Returns:
        true if this category is allowed for new processes
        Since:
        10.0.50

      • setAllowedForNewProcesses

        CategoryModifier setAllowedForNewProcesses​(boolean allowedForNewProcesses)
                                    throws ValidationException

        Change the allowed for new processes state.

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

        Parameters:
        allowedForNewProcesses - the new allowed for new processes state
        Returns:
        the CategoryModifier
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50

      • validateAllowedForNewProcesses

        boolean validateAllowedForNewProcesses​(boolean allowedForNewProcesses)
                                throws ValidationException
        Validate the given allowed for new processes state.
        Parameters:
        allowedForNewProcesses - the new allowed for new processes state
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.50