RQLResult (RoboSuite Java API)

java.lang.Object
- com.kapowtech.robosuite.api.java.rql.RQLResult

All Implemented Interfaces:

java.io.Serializable
```
public final class RQLResult
extends java.lang.Object
implements java.io.Serializable
```
Encapsulates the result of a robot execution. It contains both the original RQLRequest that was sent to the RoboServer, as well as all received RQLResponses.
The RQLResult object is a convenient way to access a number of other details. Some aspects of the result will only be applicable for specific requests:
- Execute requests: Execute requests are sent directly as ExecuteRequests, or indirectly from invoking one of the RobotExecutor.request methods. The most important point of a robot execution if often the objects that are extracted. They can be accessed by calling the getObjects method. Two other methods getByName and getBySignature provide a means of selecting what kind of objects to get.
- Stop requests: If the robot was stopped, this results in a ServerExecutionEventResponse with an event type of ExecutionEvent.STOP_REQUESTED. If the robot could not be stopped, no response is generated.
RQLResults are normally returned by calls to the static methods in RobotExecutor, but it is also possible to create your own, for example by salvaging part of a result from an RQLException containing the RQLResult and RQLResponses.
Objects of this class are immutable.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`RQLResult(RQLRequest request, java.util.List<RQLResponse> responses)` Creates a new `RQLResult` object based on the result of processing an `RQLRequest`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.util.List<ErrorResponse>`	`getErrors()` Returns a list of `ErrorResponse` objects.
`java.lang.String`	`getExecutionId()` Returns the `executionId` of the robot, This will return `null` if the request that generated this result was not an `ExecuteRequest`, or if it did not contain a response that had an `executionId` property.
`java.util.List<java.lang.String>`	`getMessages()` Returns a list of strings containing the logging messages sent by the robot.
`java.util.List`	`getObjects()` Deprecated. The `ExtractedObject` class has been deprecated due to terminology changes. Use the `getOutputObjects()` method instead.
`java.util.List`	`getObjectsByName(java.lang.String modelName)` Deprecated. The `ExtractedObject` class has been deprecated due to terminology changes. Use the method `getOutputObjects()` combined with `RQLObjects.getByName(String)` instead.
`java.util.List`	`getObjectsBySignature(java.util.List attributeNames)` Deprecated. The `ExtractedObject` class has been deprecated due to terminology changes. Use the method `getOutputObjects()` combined with `RQLObjects.getBySignature(List)` instead.
`RQLObjects`	`getOutputObjects()` Returns the output objects as an `RQLObjects` list.
`RQLObjects`	`getOutputObjectsByName(java.lang.String modelName)` Returns the output objects as an `RQLObjects` list.
`RQLObjects`	`getOutputObjectsBySignature(java.util.List attributeNames)` Returns the output objects as an `RQLObjects` list.
`java.util.List`	`getPingResponses()` Returns all `PingResponse`s in the result.
`RQLRequest`	`getRQLRequest()` Returns the `RQLRequest` that this result was generated by.
`java.util.List`	`getRQLResponses()` Returns the raw `RQLResponse`s that make up the result.
`java.util.List<RQLResponse>`	`getRQLResponsesByClass(java.lang.Class responseType)` Returns a list of `RQLResponse`s that satisfies the condition: `responseType.isInstance(response)`.
`java.lang.String`	`toString()` Returns a string representation of the object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RQLResult
```
public RQLResult(RQLRequest request,
                 java.util.List<RQLResponse> responses)
```
    Creates a new RQLResult object based on the result of processing an RQLRequest.
    
    Parameters:
    
    request - the RQLRequest that generated the result
    
    responses - a list of RQLResponses that make up the result
    
    Throws:
    
    java.lang.NullPointerException - if either parameter is null.
    
    java.lang.IllegalArgumentException - if one or more of the elements in responses are null or not RQLResponses.
- Method Detail
  - getErrors
```
public java.util.List<ErrorResponse> getErrors()
```
    Returns a list of ErrorResponse objects. These can be either RobotErrorResponses or ServerErrorResponses.
    
    Returns:
    
    a list of ErrorMessage objects.
    
    See Also:
    
    ErrorResponse, RobotErrorResponse, ServerErrorResponse
  - getMessages
```
public java.util.List<java.lang.String> getMessages()
```
    Returns a list of strings containing the logging messages sent by the robot. The individual RobotMessageResponse objects can be accessed by calling getRQLResponsesByClass(RobotMessageResponse.class).
    
    Returns:
    
    a list of strings containing the logging messages sent by the robot.
  - getObjects
```
public java.util.List getObjects()
```
    Deprecated. The ExtractedObject class has been deprecated due to terminology changes. Use the getOutputObjects() method instead.
    
    Returns a list of ExtractedObjects returned by the robot.
    
    Returns:
    
    a list of ExtractedObjects returned by the robot.
    
    See Also:
    
    RQLObject
  - getObjectsByName
```
public java.util.List getObjectsByName(java.lang.String modelName)
```
    Deprecated. The ExtractedObject class has been deprecated due to terminology changes. Use the method getOutputObjects() combined with RQLObjects.getByName(String) instead.
    
    Returns a list of ExtractedObjects with a specific name.
    The objects returned by this method will satisfy the condition: obj.getName().equals(modelName).
    
    Parameters:
    
    modelName - the required object model name
    
    Returns:
    
    a list of ExtractedObjects with a specific name
    
    Throws:
    
    java.lang.NullPointerException - if the modelName parameter was null.
  - getObjectsBySignature
```
public java.util.List getObjectsBySignature(java.util.List attributeNames)
```
    Deprecated. The ExtractedObject class has been deprecated due to terminology changes. Use the method getOutputObjects() combined with RQLObjects.getBySignature(List) instead.
    
    Returns a list of ExtractedObjects that have a specific set of attributes.
    The objects returned by this method will satisfy the condition: obj.getAttributes().keySet().containsAll(attributeNames), and it is therefore guaranteed that the objects will not throw NoSuchAttributeExceptions when queried for the given attributes.
    
    Parameters:
    
    attributeNames - a list of Strings containing the required attribute names.
    
    Returns:
    
    a list of ExtractedObjects with the specified signature.
    
    Throws:
    
    java.lang.NullPointerException - if the attributeNames parameter was null.
  - getOutputObjects
```
public RQLObjects getOutputObjects()
```
    Returns the output objects as an RQLObjects list.
    
    Returns:
    
    the output objects as an RQLObjects list.
    
    Since:
    
    1.1
  - getOutputObjectsByName
```
public RQLObjects getOutputObjectsByName(java.lang.String modelName)
```
    Returns the output objects as an RQLObjects list.
    The objects returned by this method will satisfy the condition: obj.getName().equals(modelName).
    
    Parameters:
    
    modelName - the required object model name
    
    Returns:
    
    a list of ExtractedObjects with a specific name
    
    Throws:
    
    java.lang.NullPointerException - if the modelName parameter was null.
    
    Since:
    
    1.1
  - getOutputObjectsBySignature
```
public RQLObjects getOutputObjectsBySignature(java.util.List attributeNames)
```
    Returns the output objects as an RQLObjects list.
    The objects returned by this method will satisfy the condition: obj.getAttributes().keySet().containsAll(attributeNames), and it is therefore guaranteed that the objects will not throw NoSuchAttributeExceptions when queried for the given attributes.
    
    Parameters:
    
    attributeNames - a list of Strings containing the required attribute names.
    
    Returns:
    
    a list of ExtractedObjects with the specified signature.
    
    Throws:
    
    java.lang.NullPointerException - if the attributeNames parameter was null.
    
    Since:
    
    1.1
  - getRQLRequest
```
public RQLRequest getRQLRequest()
```
    Returns the RQLRequest that this result was generated by.
    
    Returns:
    
    the RQLRequest that this result was generated by.
  - getRQLResponses
```
public java.util.List getRQLResponses()
```
    Returns the raw RQLResponses that make up the result.
    
    Returns:
    
    a list of RQLResponses that make up the result.
    
    See Also:
    
    RQLResponse
  - getRQLResponsesByClass
```
public java.util.List<RQLResponse> getRQLResponsesByClass(java.lang.Class responseType)
```
    Returns a list of RQLResponses that satisfies the condition: responseType.isInstance(response).
    
    Parameters:
    
    responseType - the type of response to check for. Can be a super-class, which results in all instances of subclasses being returned.
    
    Returns:
    
    a list of RQLResponses that make up the result.
    
    Throws:
    
    java.lang.NullPointerException - if the responseType parameter was null.
    
    See Also:
    
    RQLResponse
  - getPingResponses
```
public java.util.List getPingResponses()
```
    Returns all PingResponses in the result. The effect is identical to invoking getRQLResponsesByClass(PingResponse.class).
    
    Returns:
    
    all PingResponses in the result.
    
    See Also:
    
    PingResponse
  - getExecutionId
```
public java.lang.String getExecutionId()
```
    Returns the executionId of the robot, This will return null if the request that generated this result was not an ExecuteRequest, or if it did not contain a response that had an executionId property.
    
    Returns:
    
    the executionId of the robot, or null if the request was not an ExecuteRequest or the robot could not be assigned an id.
    
    See Also:
    
    ServerExecutionEventResponse, RobotResponse
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation of the object.

Class RQLResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RQLResult

Method Detail

getErrors

getMessages

getObjects

getObjectsByName

getObjectsBySignature

getOutputObjects

getOutputObjectsByName

getOutputObjectsBySignature

getRQLRequest

getRQLResponses

getRQLResponsesByClass

getPingResponses

getExecutionId

toString