com.kapowtech.robosuite.api.java.rql

Class AbstractRequest

java.lang.Object

com.kapowtech.robosuite.api.java.rql.AbstractRequest

Direct Known Subclasses:

QueuedRequest, Request

public abstract class AbstractRequest
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<RQLObjectBuilder>	_objectBuilders
protected java.lang.String	_project
protected java.lang.String	_robotURL

Constructor Summary

Constructors

Constructor and Description
AbstractRequest()

Method Summary

Modifier and Type	Method and Description
RQLObjectBuilder	createInputVariable(java.lang.String name) Creates a new Input Object with the specified name, and returns an RQLObjectBuilder that can be used to build the object.
void	createInputVariable(java.lang.String name, RQLObject object) Creates a new Input Object with the specified name, from an RQLObject.
abstract RQLResult	execute() Executes this request and blocks until the robot has completed or an error occurs.
abstract void	execute(RobotResponseHandler handler) Executes this request asynchronously and uses the handler to call back with results and status updates.
protected RQLObjects	getInputObjects() Returns the currently configured input objects, as a list of RQLObjects.
java.lang.String	getProject() Get the project for this request
java.lang.String	getRobotURL() Returns the currently configured robotURL property.
AbstractRequest	setProject(java.lang.String project) Set the project name that this request.
void	setRobotURL(java.lang.String robotURL) Returns the currently configured robotURL property.
abstract void	setStopRobotOnApiException(boolean stopOnError) When set, the robot will be stopped on RoboServer after the first API exception is sent back to the client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_robotURL

protected java.lang.String _robotURL

_objectBuilders

protected java.util.List<RQLObjectBuilder> _objectBuilders

_project

protected java.lang.String _project

Constructor Detail

AbstractRequest

public AbstractRequest()

Method Detail

execute

public abstract RQLResult execute()
                           throws RQLException

Executes this request and blocks until the robot has completed or an error occurs.

Returns:

the RQLResult with the responses from the execution

Throws:

RQLException - if the execution fails

execute

public abstract void execute(RobotResponseHandler handler)
                      throws RQLException

Executes this request asynchronously and uses the handler to call back with results and status updates.

Parameters:

handler - the response handler to use

Throws:

RQLException - in case the immediate execution fails

setStopRobotOnApiException

public abstract void setStopRobotOnApiException(boolean stopOnError)

When set, the robot will be stopped on RoboServer after the first API exception is sent back to the client.

Parameters:

stopOnError - true if the robot should stop after the robot generates an API exception, false if you want the robot to continue execution even id the Robot generates API exceptions. The Default is true

getRobotURL

public java.lang.String getRobotURL()

Returns the currently configured robotURL property.

The robot URL specifies to RoboServer where to look for the robot to execute. A robot URL can be use a library protocol, which looks like this: library:/google.robot. When RoboServer receives such a URL, it looks up the robot in the configured library.

Returns:

the currently configured robotURL property.

setRobotURL

public void setRobotURL(java.lang.String robotURL)

Returns the currently configured robotURL property.

The robot URL specifies to RoboServer where to look for the robot to execute. A robot URL can be use a library protocol, which looks like this: library:/google.robot. When RoboServer receives such a URL, it looks up the robot in the configured library.

Parameters:

robotURL - the new URL to the robot.

createInputVariable

public RQLObjectBuilder createInputVariable(java.lang.String name)

Creates a new Input Object with the specified name, and returns an RQLObjectBuilder that can be used to build the object.

Parameters:

name - the name of the input object.

Returns:

an RQLObjectBuilder that can be used to build the object.

createInputVariable

public void createInputVariable(java.lang.String name,
                                RQLObject object)

Creates a new Input Object with the specified name, from an RQLObject. This is useful if responses from one Robot should be used as input to another

Parameters:

name - the name of the input object.

object - the rql object

getProject

public java.lang.String getProject()

Get the project for this request

Returns:

the project name or null if not configured

setProject

public AbstractRequest setProject(java.lang.String project)

Set the project name that this request. This property is only used for logging purposes, it controls what RoboServer will write in the PROJECT_NAME column in the log database. This has no direct relation to the RepositoryRobotLibrary, although using a RepositoryRobotLibrary will override the value set here.

Parameters:

project - the project name

Returns:

a reference to the Request object (this)

getInputObjects

protected RQLObjects getInputObjects()

Returns the currently configured input objects, as a list of RQLObjects.

Returns:

the currently configured input objects, as a list of RQLObjects.