ModifiableAgentPauseState (ecom-api-iagent 12.27.2 API)

All Superinterfaces:

AgentPauseState
```
public interface ModifiableAgentPauseState
extends AgentPauseState
```
This interface provides information about the agent pause state and also allows to change it. Any changes applied to an instance of ModifiableAgentPauseState will take effect immediately.

Since:

11.16

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`pause()`	This method puts the agent into pause state.
`boolean`	`pause(PauseReason pauseReason)`	This method puts the agent into pause state with the specified `PauseReason`.
`boolean`	`resume()`	This method resumes the agent from pause state.

Methods inherited from interface com.novomind.ecom.api.iagent.common.AgentPauseState
getPauseReason, isPaused, isPauseRequested

- Method Detail
  - pause
```
boolean pause()
       throws OperationFailedException
```
    This method puts the agent into pause state. Please note that the agent pause state can only be applied to a User that is logged on as agent at the iAGENT Desk.
    
    Returns:
    
    true if the state has been changed
    
    Throws:
    
    OperationFailedException - if the operation failed e.g. in case of logged off agent
    
    Since:
    
    11.16
  - pause
```
boolean pause(PauseReason pauseReason)
       throws OperationFailedException
```
    This method puts the agent into pause state with the specified PauseReason. Please note that the agent pause state can only be applied to a User that is logged on as agent at the iAGENT Desk.
    
    Parameters:
    
    pauseReason - The PauseReason for the pause
    
    Returns:
    
    true if the state has been changed
    
    Throws:
    
    OperationFailedException - if the operation failed e.g. in case of logged off agent
    
    Since:
    
    11.16
  - resume
```
boolean resume()
        throws OperationFailedException
```
    This method resumes the agent from pause state. Please note that the agent pause state can only be resumed for a User that is logged on as agent at the iAGENT Desk.
    
    Returns:
    
    true if the state has been changed
    
    Throws:
    
    OperationFailedException - if the operation failed e.g. in case of logged off agent
    
    Since:
    
    11.16