Package com.novomind.ecom.api.iagent.common

Interface ModifiableAgentAvailability

All Superinterfaces:
AgentAvailability
public interface ModifiableAgentAvailability extends AgentAvailability
Represents the agent availability states for specific module and allows to change it. Any changes applied to an instance of ModifiableAgentAvailability will take effect immediately. Please note that agent availability state changes can only be applied to a User that is logged on as agent at the iAGENT Desk.
Since:
11.16

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isStateChangePerModuleEnabled()
    The method checks if the agent has the ability to change his availability state individually per module.
    boolean
    setAvailable(boolean isAvailable)
    The method changes the general agent availability state and is not module specific.
    boolean
    setAvailableForCall(boolean isAvailableForCall)
    The method changes the agent availability state for this agent for calls.
    boolean
    setAvailableForChat(boolean isAvailableForChat)
    The method changes the agent availability state for this agent for chats.
    boolean
    setAvailableForMail(boolean isAvailableForMail)
    The method changes the agent availability state for this agent for mails.

    Methods inherited from interface com.novomind.ecom.api.iagent.common.AgentAvailability

    isAvailable, isAvailableForCall, isAvailableForChat, isAvailableForMail

  • Method Details

    • isStateChangePerModuleEnabled

      boolean isStateChangePerModuleEnabled()
      The method checks if the agent has the ability to change his availability state individually per module. If the agent is not allowed to change his availability per module the availability state can only be changed for all modules. If the ability to change the state per module is enabled the availability state must be set individually per module using the module specific methods.
      Returns:
      true if the user is allowed to change his availability state per module, otherwise false.
      Since:
      11.16

    • setAvailable

      boolean setAvailable(boolean isAvailable) throws OperationFailedException
      The method changes the general agent availability state and is not module specific. Please note that the method will throw an OperationFailedException if the agent is only allowed to change state individually per module.
      Parameters:
      isAvailable - the agent's general availability as boolean to be applied
      Returns:
      true if the state has been changed
      Throws:
      OperationFailedException - if the operation has failed e.g. if the agent has logged off
      Since:
      11.16

    • setAvailableForMail

      boolean setAvailableForMail(boolean isAvailableForMail) throws OperationFailedException
      The method changes the agent availability state for this agent for mails. Please note that the method will throw an OperationFailedException if the agent is not allowed to change state individually per module.
      Parameters:
      isAvailableForMail - the agent's availability for mails as boolean to be applied
      Returns:
      true if the state has been changed
      Throws:
      OperationFailedException - if the operation has failed e.g. if the agent has logged off
      Since:
      11.16

    • setAvailableForChat

      boolean setAvailableForChat(boolean isAvailableForChat) throws OperationFailedException
      The method changes the agent availability state for this agent for chats. Please note that the method will throw an OperationFailedException if the agent is not allowed to change state individually per channel.
      Parameters:
      isAvailableForChat - the agent's availability for chats as boolean to be applied
      Returns:
      true if the state has been changed
      Throws:
      OperationFailedException - if the operation has failed e.g. if the agent has logged off
      Since:
      11.16

    • setAvailableForCall

      boolean setAvailableForCall(boolean isAvailableForCall) throws OperationFailedException
      The method changes the agent availability state for this agent for calls. Please note that the method will throw an OperationFailedException if the agent is not allowed to change state individually per module.
      Parameters:
      isAvailableForCall - the agent's availability for calls as boolean to be applied
      Returns:
      true if the state has been changed
      Throws:
      OperationFailedException - if the operation has failed e.g. if the agent has logged off
      Since:
      11.16