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

Class StopRequest

java.lang.Object

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

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

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

All Implemented Interfaces:

java.io.Serializable

public final class StopRequest
extends RQLRequest

The StopRequest is an RQLRequest that requests a robot to stop executing on a server.

The StopRequest has an executionId property whose value refers to the robot execution to stop by an execution id returned previously in a ServerExecutionEventResponse.

See Also:

ServerExecutionEventResponse, Serialized Form

Field Summary

Fields inherited from class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest

AUTHENTICATION_ENABLED_PREFIX, TRIAL_VERSION_LIMITATION_PREFIX

Constructor Summary

Constructors

Constructor and Description
StopRequest(java.lang.String executionId) Creates a StopRequest with the specified execution id.
StopRequest(java.lang.String hostName, java.lang.String ipAddress, java.lang.String executionId, java.lang.String username, java.lang.String password) Package private constructor for initializing ipAddress and hostName properties with credentials.

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	getExecutionId() Returns the execution id.
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.RQLRequest

getHostName, getIPAddress, getPassword, getUsername

Methods inherited from class java.lang.Object

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

Constructor Detail

StopRequest

public StopRequest(java.lang.String executionId)

Creates a StopRequest with the specified execution id.

Parameters:

executionId - the execution id.

StopRequest

public StopRequest(java.lang.String hostName,
                   java.lang.String ipAddress,
                   java.lang.String executionId,
                   java.lang.String username,
                   java.lang.String password)

Package private constructor for initializing ipAddress and hostName properties with credentials.

It is used to re-create an RQL Request from an XML stream. 10. may 2010 (KG) Has been made public to allow stop to use credentials

Parameters:

hostName - hostname of destination, may be null

ipAddress - ip address iof destination, may be null

executionId - the execution id of the robot to stop

username - username used for authenticating this request

password - password used for authenticating this request

Method Detail

getExecutionId

public java.lang.String getExecutionId()

Returns the execution id.

Returns:

the execution id.

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 RQLRequest

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 RQLRequest

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 RQLRequest

Returns:

a human readable string representation of this object.