Package com.tnsai.actions.model

Record Class ActionResponse

java.lang.Object
java.lang.Record
com.tnsai.actions.model.ActionResponse
Record Components:
value - the result value (may be null on failure)
success - whether the action completed successfully
error - the error message (null on success)
public record ActionResponse(Object value, boolean success, String error) extends Record
Typed response from action execution.

Replaces the untyped Object return from Agent.executeAction(String, Map) with a structured result carrying success/failure status and an optional error message.

Usage: 


 ActionResponse response = agent.executeAction(request);

 if (response.success()) {
     Object data = response.value();
     // process result
 } else {
     logger.error("Action failed: {}", response.error());
 }
Since:
0.3.0
See Also:

  • Constructor Details

    • ActionResponse

      public ActionResponse(Object value, boolean success, String error)
      Creates an instance of a ActionResponse record class.
      Parameters:
      value - the value for the value record component
      success - the value for the success record component
      error - the value for the error record component

  • Method Details

    • success

      public static ActionResponse success(Object value)
      Creates a successful response with the given value.
      Parameters:
      value - the result value
      Returns:
      a successful ActionResponse

    • failure

      public static ActionResponse failure(String error)
      Creates a failure response with the given error message.
      Parameters:
      error - the error message (must not be null)
      Returns:
      a failed ActionResponse

    • failure

      public static ActionResponse failure(String error, Object partialValue)
      Creates a failure response with the given error message and partial value.
      Parameters:
      error - the error message (must not be null)
      partialValue - any partial result available despite the failure
      Returns:
      a failed ActionResponse

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • value

      public Object value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • success

      public boolean success()
      Returns the value of the success record component.
      Returns:
      the value of the success record component

    • error

      public String error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component