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

Provides classes for the language constructs in the Robot Query Language (RQL).

See: Description

Interface Summary

Interface	Description
Environment	Represents a specific setting that is passed to the robot before it begins execution.
ErrorResponse	The error response interface provides a common view of the two types of error responses - RobotErrorResponse and ServerErrorResponse.
FileBasedRobotLibrary	Represents a single packed (zipped) robot library.
FolderBasedRobotLibrary	Represents a robot library in unpacked form.
MessageEnvironment	The MessageEnvironment specifies how robot generated status messages are handled, such as stored in a database, written to a file, or sent via email.
RobotLibrary	Represents a robot library or workspace.

Class Summary

Class	Description
AppKeyCustomEnvironment	Application key environment.
Attribute	Represents an attribute as an entry in an ExtractedObject or a QueryParameter.
AttributeType	Represents type-information about the attributes in Input or Output Objects.
Binary	Represents a Binary RoboSuite value.
CommonRobotEnvironment	The CommonRobotEnvironment is an Environment that applies the following special conditions to the execution of a robot: totalTimeLimit is a time limit on the total robot execution time.
Cookie	Represents a cookie held by the robot.
Cookies	An immutable list of Cookies.
CustomEnvironment	A CustomEnvironment can be used to send custom environments to RoboServer.
Database
DatabaseEnvironment
DefaultRobotLibrary	Represents RoboServer's Default Project Robot Library.
EmailMessageEnvironment	The Email Message Environment is a Message Environment that sends a email if any error messages were generated during the robot execution.
EmbeddedFileBasedRobotLibrary	Represents a robot library that will be embedded in the ExecuteRequest that is sent to the robot server.
Environments	A robot is always run using a list of environments.
ExecuteRequest	The ExecuteRequest is an RQLRequest that requests a robot to be executed on a server.
ExecutionEvent	Typesafe enumeration representing an execution event.
ExecutionStatus	Typesafe enumeration representing an execution status.
ExtractedObject	Deprecated The term Extracted Object has been replaced with Output Object.
InputObjectEnvironment	The Input Object Environment passes on Input Objects to a robot that requires them as parameters.
InternalRequest	This request is used to transport internal RoboSuite RQL Requests from one RoboSuite application to another.
InternalResponse	This response is used to transport internal RoboSuite RQL Responses from one RoboSuite application to another.
MultiplexingRQLConstruct	A wrapper for RQLConstructs when used with a MultiplexingRQLProtocol.
MultiplexingVirtualConnectionClosed	A Marker response sent by the server to indicate the all responses related to the current request have been sent This is to let the client know that there is no more data on the virtual connection
PingRequest	The Ping Request can be used to ping a RoboServer.
PingResponse	A Ping Response is returned by RoboServer, after it receives a Ping Request.
RepositoryRobotLibrary	A Robot Library which uses the Platform repository.
Resource	Information for the direct acquisition of the reservable resource
ResourceEnvironment	A reservable resource environment provides information needed to directly acquire resources
RobotErrorResponse	A RobotErrorResponse is a RobotResponse that contains a robot generated error status message.
RobotMessageResponse	A RobotMessageResponse is a RobotResponse that contains a robot generated non-error status message.
RobotOutputObjectResponse	A RobotOutputObjectResponse is a RobotResponse that contains an extracted object.
RobotResponse	A RobotResponse is an RQLResponse that contains information related to the execution of a robot.
RobotStatus	The status of a robot on RoboServer.
RQLConstruct	An RQLConstruct is an object representation of a language construct of the Robot Query Language (RQL).
RQLObject	Represents an object that can be passed as input to a robot, or returned as output when the robot is executed.
RQLObjects	Represents a collection of Input or Output Objects sent to or received from a robot.
RQLRequest	An RQLRequest is an RQLConstruct that request some service.
RQLResponse	An RQLResponse is an RQLConstruct sent as a response to an RQLRequest.
ScheduleRequest
ServerErrorResponse	A ServerErrorResponse is a ServerResponse that contains error information related to the operation of the server sending the response.
ServerExecutionEventResponse	A ServerExecutionEventResponse is a ServerInfoResponse that contains event information related to the execution of a robot, such as it being started and stopped.
ServerInfoResponse	A ServerInfoResponse is a ServerResponse that contains non-error information related to the operation of the server sending the response.
ServerResponse	A ServerResponse is an RQLResponse that contains information related to the operation of the server sending the response.
Session	Represents a session held by a robot.
ShutdownMethod	Argument controling how RoboServer should shutdown
ShutdownRequest	Request object sent to RoboServer to Restart it or Shut it down
StatusRequest	Requests that causes RoboServer to send back a StatusResponse with details about executing Robots.
StatusResponse	Response containing runtime data for the robots executing on RoboServer
StopRequest	The StopRequest is an RQLRequest that requests a robot to stop executing on a server.
ThreadDumpRequest	Request sent to RoboServer to perform a thread dump of all threads, and return them as a ThreadDumpResponse
ThreadDumpResponse	Response from RoboServer containing Thread dump string
URLFileBasedRobotLibrary	Sends a packed robot library as a URL reference.
URLFolderBasedRobotLibrary	An unpacked robot library placed in the local filesystem of the RoboServer.

Exception Summary

Exception	Description
AttributeParseException	Signals an error when converting an attribute from a string to a given type.
InvalidAttributeTypeException	Signals that an invalid attribute type was inserted into a QueryParameter or ExtractedObject.

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

Provides classes for the language constructs in the Robot Query Language (RQL).

It is recommended that you read the RoboServer User's Guide before using this package.