kaos.core.csi.command
Interface Command

All Known Implementing Classes:

ActivMedia, Amigo, AMptzCamera, AMptzCameraSonar, AMsonar, BreveBot, CommandImpl, ER1, Fran, Ivan, KAoSPlayer, KAoSRobot, KAoSRobotExample, KAoSRobotTest, KBot, MinimalStubBot, Pioneer, StubBot, StubBot

public interface Command

Defines the operation to send a command to an entity. All commands are handle as if remote, and thus are asynchronous

Method Summary

java.lang.String	requestAction(FeedbackReceiver feedbackReceiver, KAoSEntityDescription receiverDesc, java.lang.String owlActionDescription) This method sends a command to an entity identified by the given receiverDesc to perform an action described by the given String, which is in the OWL format.
java.lang.String	requestAction(FeedbackReceiver feedbackReceiver, KAoSEntityDescription receiverDesc, java.lang.String actionName, java.util.HashMap properties) This method sends a command to an entity identified by the given receiverDesc to perform an action described by the given action name and properties.
java.lang.String	requestAction(FeedbackReceiver feedbackReceiver, java.lang.String receiverID, java.lang.String owlActionDescription) This method sends a command to an entity identified by the given receiverID to perform an action described by the given String, which is in the OWL format.
java.lang.String	requestAction(FeedbackReceiver feedbackReceiver, java.lang.String receiverID, java.lang.String actionName, java.util.HashMap properties) This method sends a command to an entity identified by the given receiverID to perform an action described by the given action name and properties.
java.lang.Object	requestAction(KAoSEntityDescription receiverDesc, java.lang.String actionName, java.util.HashMap properties) This method sends a command to an entity identified by the given receiverDesc to perform an action described by the given action name and roperties.
java.lang.Object	requestAction(java.lang.String receiverID, java.lang.String actionName, java.util.HashMap properties) This method sends a command to an entity identified by the given receiverID to perform an action described by the given action name and properties.

Method Detail

requestAction

java.lang.String requestAction(FeedbackReceiver feedbackReceiver,
                               java.lang.String receiverID,
                               java.lang.String owlActionDescription)
                               throws ActionFailureException,
                                      NotLocatableException,
                                      TransportFailure

This method sends a command to an entity identified by the given receiverID to perform an action described by the given String, which is in the OWL format. Feedback from the action execution is sent to the given feedbackReceiver.

Parameters:

feedbackReceiver - is the FeedbackReceiver requesting the action. All feedback from the action execution will be sent to it.

receiverID - is the String that identifies the entity, which is requested to perform the action. The receiverID is the one that the action executor has registered with KAoS.

owlActionDescription - is an OWL String that describes the action. It includes the action name and all action properties and their values.

Returns:

String containing the unique id of the requested action. This id will be used by the FeedbackReceiver to track the status of action execution.

Throws:

ActionFailureException - containing the reason for failure. See ontology to determine specific reasons available for a given action

NotLocatableException - when the entity reqested to perform the action cannot be located.

TransportFailure

requestAction

java.lang.String requestAction(FeedbackReceiver feedbackReceiver,
                               java.lang.String receiverID,
                               java.lang.String actionName,
                               java.util.HashMap properties)
                               throws ActionFailureException,
                                      NotLocatableException,
                                      TransportFailure

This method sends a command to an entity identified by the given receiverID to perform an action described by the given action name and properties. Feedback from the action execution is sent to the given feedbackReceiver.

Parameters:

feedbackReceiver - is the FeedbackReceiver requesting the action. All feedback from the action execution will be sent to it.

receiverID - is the String that identifies the entity, which is requested to perform the action. The receiverID is the one that the action executor has registered with KAoS.

actionName - is a String representing the name of the action as defined in the associated ontology.

properties - is an HashMap of ontological Strings representing the desired properties of the action and the associated values.

Returns:

String containing the unique id of the requested action. This id will be used by the FeedbackReceiver to track the status of action execution.

Throws:

ActionFailureException - containing the reason for failure. See ontology to determine specific reasons available for a given action

NotLocatableException - when the entity reqested to perform the action cannot be located.

TransportFailure

requestAction

java.lang.String requestAction(FeedbackReceiver feedbackReceiver,
                               KAoSEntityDescription receiverDesc,
                               java.lang.String owlActionDescription)
                               throws ActionFailureException,
                                      NotLocatableException,
                                      TransportFailure

This method sends a command to an entity identified by the given receiverDesc to perform an action described by the given String, which is in the OWL format. Feedback from the action execution is sent to the given feedbackReceiver.

Parameters:

feedbackReceiver - is the FeedbackReceiver requesting the action. All feedback from the action execution will be sent to it.

receiverDesc - is KAosEntityDescription of the entity, which is requested to perform the action.

owlActionDescription - is an OWL String that describes the action. It includes the action name and all action properties and their values.

Returns:

String containing the unique id of the requested action. This id will be used by the FeedbackReceiver to track the status of action execution.

Throws:

ActionFailureException - containing the reason for failure. See ontology to determine specific reasons available for a given action

NotLocatableException - when the entity reqested to perform the action cannot be located.

TransportFailure

requestAction

java.lang.String requestAction(FeedbackReceiver feedbackReceiver,
                               KAoSEntityDescription receiverDesc,
                               java.lang.String actionName,
                               java.util.HashMap properties)
                               throws ActionFailureException,
                                      NotLocatableException,
                                      TransportFailure

This method sends a command to an entity identified by the given receiverDesc to perform an action described by the given action name and properties. Feedback from the action execution is sent to the given feedbackReceiver.

Parameters:

feedbackReceiver - is the FeedbackReceiver requesting the action. All feedback from the action execution will be sent to it.

receiverDesc - is KAosEntityDescription of the entity, which is requested to perform the action.

actionName - is a String representing the name of the action as defined in the associated (with the action) ontology.

properties - is an HashMap of ontological Strings representing the desired properties of the action and the associated values.

Returns:

String containing the unique id of the requested action. This id will be used by the FeedbackReceiver to track the status of action execution.

Throws:

ActionFailureException - containing the reason for failure. See ontology to determine specific reasons available for a given action

NotLocatableException - when the entity reqested to perform the action cannot be located.

TransportFailure

requestAction

java.lang.Object requestAction(java.lang.String receiverID,
                               java.lang.String actionName,
                               java.util.HashMap properties)
                               throws ActionFailureException,
                                      NotLocatableException,
                                      TransportFailure

This method sends a command to an entity identified by the given receiverID to perform an action described by the given action name and properties. The result is returned synchronously to the caller.

Parameters:

receiverID - is the String that identifies the entity, which is requested to perform the action. The receiverID is the one that the action executor has registered with KAoS.

actionName - is a String representing the name of the action as defined in the associated ontology.

properties - is a HashMap of Strings representing names of the desired properties as defined in the associated ontology and their values.

Returns:

Object containing the result of the requested action.

Throws:

ActionFailureException - containing the reason for failure. See ontology to determine specific reasons available for a given action

NotLocatableException - when the entity reqested to perform the action cannot be located.

TransportFailure

requestAction

java.lang.Object requestAction(KAoSEntityDescription receiverDesc,
                               java.lang.String actionName,
                               java.util.HashMap properties)
                               throws ActionFailureException,
                                      NotLocatableException,
                                      TransportFailure

This method sends a command to an entity identified by the given receiverDesc to perform an action described by the given action name and roperties. The result will be returned synchronously.

Parameters:

receiverDesc - is KAosEntityDescription of the entity, which is requested to perform the action.

actionName - is a String representing the name of the action as defined in the associated ontology.

properties - is a HashMap of Strings representing names of the desired properties as defined in the associated ontology and their values.

Returns:

Object containing result of the requested action.

Throws:

ActionFailureException - containing the reason for failure. See ontology to determine specific reasons available for a given action

NotLocatableException - when the entity reqested to perform the action cannot be located.

TransportFailure