Package io.goobi.viewer.api.rest.model

Class SuccessMessage

java.lang.Object
io.goobi.viewer.api.rest.model.SuccessMessage
All Implemented Interfaces:
IResponseMessage
public class SuccessMessage extends Object implements IResponseMessage
REST API response model indicating whether an operation succeeded, together with an optional human-readable result description. Implements IResponseMessage and is serialized as JSON for operation-result responses.
Author:
Florian Alpers

  • Constructor Details

    • SuccessMessage

      public SuccessMessage(boolean success, String message)
      Creates a new SuccessMessage instance.
      Parameters:
      success - true if the operation succeeded
      message - human-readable result description

    • SuccessMessage

      public SuccessMessage(boolean success)
      Creates a new SuccessMessage instance.
      Parameters:
      success - true if the operation succeeded

  • Method Details

    • isSuccess

      public boolean isSuccess()
      isSuccess.
      Returns:
      true if the operation succeeded, false otherwise

    • getMessage

      public String getMessage()
      Getter for the field message.
      Specified by:
      getMessage in interface IResponseMessage
      Returns:
      the human-readable result description

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object