com.kapowtech.robosuite.api.java.rql.construct

Class RobotMessageResponse

java.lang.Object

com.kapowtech.robosuite.api.java.rql.construct.RQLConstruct

com.kapowtech.robosuite.api.java.rql.construct.RQLResponse

com.kapowtech.robosuite.api.java.rql.construct.RobotResponse

com.kapowtech.robosuite.api.java.rql.construct.RobotMessageResponse

All Implemented Interfaces:

java.io.Serializable

public final class RobotMessageResponse
extends RobotResponse

A RobotMessageResponse is a RobotResponse that contains a robot generated non-error status message.

If no MessageEnvironment has been provided to an ExecuteRequest, then the server will respond with one RobotMessageResponse for each non-error status message generated by the robot.

The RobotMessageResponse has a message property whose value is a readable description of the message.

See Also:

MessageEnvironment, ExecuteRequest, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RobotMessageResponse(java.util.Date date, java.lang.String robotFileURL, java.lang.String executionId, int robotRunId, int robotId, java.lang.String message) Creates a RobotMessageResponse with the specified property values.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns true if this object and the specified object have the same property values, and false otherwise.
java.lang.String	getMessage() Returns the message.
int	hashCode() Returns the hash code of this object based on property values.
java.lang.String	toString() Returns a human readable string representation of this object.

Methods inherited from class com.kapowtech.robosuite.api.java.rql.construct.RobotResponse

getExecutionId, getRobotId, getRobotRunId, getRobotURL

Methods inherited from class com.kapowtech.robosuite.api.java.rql.construct.RQLResponse

getDate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RobotMessageResponse

public RobotMessageResponse(java.util.Date date,
                            java.lang.String robotFileURL,
                            java.lang.String executionId,
                            int robotRunId,
                            int robotId,
                            java.lang.String message)

Creates a RobotMessageResponse with the specified property values. This constrictor is subject to change if the RQL protocol is extended

Parameters:

date - the date at which the response was created by the server.

robotFileURL - the robot file URL.

executionId - the execution id.

robotRunId - the robot run id.

robotId - the robot id.

message - the message.

Method Detail

getMessage

public java.lang.String getMessage()

Returns the message.

Returns:

the message.

equals

public boolean equals(java.lang.Object obj)

Returns true if this object and the specified object have the same property values, and false otherwise.

Overrides:

equals in class RobotResponse

Parameters:

obj - the object to test for equality.

Returns:

true if this object and the specified object have the same property values, and false otherwise.

hashCode

public int hashCode()

Returns the hash code of this object based on property values.

Overrides:

hashCode in class RobotResponse

Returns:

the hash code of this object based on property values.

toString

public java.lang.String toString()

Returns a human readable string representation of this object.

Overrides:

toString in class RobotResponse

Returns:

a human readable string representation of this object.