Package com.orchestranetworks.userservice

# Interface UserServiceAjaxResponse

public interface UserServiceAjaxResponse
This interface provides methods to generate a response when processing an Ajax request.

Since:
  5.8.0

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addError(String aMessage)`
  Adds an error message to the message box.
  `void`
  `addInfo(String aMessage)`
  Adds an information message to the message box.
  `void`
  `addMessage(UserMessage aMessage)`
  Adds a message to the message box according to its severity.
  `void`
  `addWarning(String aMessage)`
  Adds a warning message to the message box.
  `UserServiceWriter`
  `getWriter()`
  Returns the writer to use to add HTML or data to the response.

- ## Method Details

  - ### getWriter

    UserServiceWriter getWriter()
    Returns the writer to use to add HTML or data to the response.
    Returns:
      the writer. Is never `null`.

  - ### addMessage

    void addMessage(UserMessage aMessage)
    Adds a message to the message box according to its severity.
    Parameters:
      `aMessage` - the message.

  - ### addError

    void addError(String aMessage)
    Adds an error message to the message box.
    Parameters:
      `aMessage` - the message.
    See Also:
      - `addMessage(UserMessage)`

  - ### addWarning

    void addWarning(String aMessage)
    Adds a warning message to the message box.
    Parameters:
      `aMessage` - the message.
    See Also:
      - `addMessage(UserMessage)`

  - ### addInfo

    void addInfo(String aMessage)
    Adds an information message to the message box.
    Parameters:
      `aMessage` - the message.
    See Also:
      - `addMessage(UserMessage)`