Interface ResponseCollect

All Known Implementing Classes:
ResponseCollectMessage
public interface ResponseCollect
Aggregated response collected from multiple logic servers.

Holds a list of individual Response objects together with a top-level error code and message that indicate the overall outcome of the collect operation.

Since:
25.1
Author:
渔民小镇
date:
2025-09-16

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getErrorCode()
    Get the overall error code. 0 indicates success; any other value indicates an error.
    String
    getErrorMessage()
    Get the human-readable error message.
    List<Response>
    getResponseList()
    Get the list of individual responses collected from logic servers.
    default boolean
    isSuccess()
    Check whether the collect operation completed successfully.
    default void
    setError(ErrorInformation error)
    Populate the error code and message from the given ErrorInformation.
    void
    setErrorCode(int errorCode)
    Set the overall error code. 0 indicates success; any other value indicates an error.
    void
    setErrorMessage(String errorMessage)
    Set the human-readable error message.

  • Method Details

    • getResponseList

      List<Response> getResponseList()
      Get the list of individual responses collected from logic servers.
      Returns:
      the response list

    • getErrorCode

      int getErrorCode()
      Get the overall error code. 0 indicates success; any other value indicates an error.
      Returns:
      the error code

    • setErrorCode

      void setErrorCode(int errorCode)
      Set the overall error code. 0 indicates success; any other value indicates an error.
      Parameters:
      errorCode - the error code

    • getErrorMessage

      String getErrorMessage()
      Get the human-readable error message.
      Returns:
      the error message, or null on success

    • setErrorMessage

      void setErrorMessage(String errorMessage)
      Set the human-readable error message.
      Parameters:
      errorMessage - the error message

    • setError

      default void setError(ErrorInformation error)
      Populate the error code and message from the given ErrorInformation.
      Parameters:
      error - the error information source

    • isSuccess

      default boolean isSuccess()
      Check whether the collect operation completed successfully.
      Returns:
      true if the error code is 0