Package com.novomind.ecom.api.iagent.messenger.persistence

Interface MessengerAccountModifier

All Superinterfaces:
IntermediateStorageProvider, Modifier<MessengerAccount>, UndeletableModifier<MessengerAccount>
public interface MessengerAccountModifier extends UndeletableModifier<MessengerAccount>, IntermediateStorageProvider
Defines an API to modify an instance of type MessengerAccount
Since:
12.20

  • Method Details

    • getName

      String getName()
      Get the current messenger account name which is held in this MessengerAccountModifier.
      Returns:
      the name as String
      Since:
      12.20

    • setName

      MessengerAccountModifier setName(String name) throws ValidationException

      Change the name of the associated MessengerAccount.

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

      Parameters:
      name - the new name as String
      Returns:
      the MessengerAccountModifier
      Throws:
      ValidationException - if the new name is invalid
      Since:
      12.20

    • 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:
      12.20

    • getProtocol

      String getProtocol()
      Get the current protocol which is held in this MessengerAccountModifier.
      Returns:
      the protocol as String
      Since:
      12.20

    • setProtocol

      MessengerAccountModifier setProtocol(String protocol) throws ValidationException

      Change the protocol of the associated MessengerAccount.

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

      Parameters:
      protocol - the new protocol as String
      Returns:
      the MessengerAccountModifier
      Throws:
      ValidationException - if the new protocol is invalid
      Since:
      12.20

    • validateProtocol

      boolean validateProtocol(String protocol) throws ValidationException
      Validate the given protocol.
      Parameters:
      protocol - the protocol to validate as String
      Returns:
      true if the protocol is valid
      Throws:
      ValidationException - if the protocol is invalid
      Since:
      12.20

    • getChannel

      ChatChannel getChannel()
      Get the current chat channel which is held in this MessengerAccountModifier.
      Returns:
      the chat channel
      Since:
      12.20

    • setChannel

      MessengerAccountModifier setChannel(ChatChannel chatChannel) throws ValidationException

      Change the chat channel of the associated MessengerAccount.

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

      Parameters:
      chatChannel - the new chat channel
      Returns:
      the MessengerAccountModifier
      Throws:
      ValidationException - if the new chat channel is invalid
      Since:
      12.20

    • validateChannel

      boolean validateChannel(ChatChannel chatChannel) throws ValidationException
      Validate the given chat channel.
      Parameters:
      chatChannel - the chat channel to validate
      Returns:
      true if the chat channel is valid
      Throws:
      ValidationException - if the chat channel is invalid
      Since:
      12.20

    • getTenant

      Tenant getTenant()
      Get the current tenant which is held in this MessengerAccountModifier.
      Returns:
      the tenant
      Since:
      12.20

    • setTenant

      MessengerAccountModifier setTenant(Tenant tenant) throws ValidationException

      Change the tenant of the associated MessengerAccount.

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

      Parameters:
      tenant - the new tenant
      Returns:
      the MessengerAccountModifier
      Throws:
      ValidationException - if the new tenant is invalid
      Since:
      12.20

    • validateTenant

      boolean validateTenant(Tenant tenant) throws ValidationException
      Validate the given tenant.
      Parameters:
      tenant - the tenant to validate
      Returns:
      true if the tenant is valid
      Throws:
      ValidationException - if the tenant is invalid
      Since:
      12.20

    • isEnabled

      boolean isEnabled()
      Get the current enabled state which is held in this MessengerAccountModifier.
      Returns:
      the enabled state
      Since:
      12.20

    • setEnabled

      MessengerAccountModifier setEnabled(boolean enabled) throws ValidationException

      Change the enabled state of the associated MessengerAccount.

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

      Parameters:
      enabled - the new enabled state
      Returns:
      the MessengerAccountModifier
      Throws:
      ValidationException - if the new enabled state cannot be applied
      Since:
      12.20

    • validateEnabled

      boolean validateEnabled(boolean enabled) throws ValidationException
      Validate the given enabled.
      Parameters:
      enabled - the enabled state to validate
      Returns:
      true if the enabled is valid
      Throws:
      ValidationException - if the enabled is invalid
      Since:
      12.20