kaos.core.csi.request
Interface HashMapRequestManager

All Known Subinterfaces:
RequestManager

public interface HashMapRequestManager

Defines the operations to send a request expressed by a String containing the action name and, in some cases, a HashMap containing the action properties.

Author:
KAoS Team

Method Summary
 java.lang.String sendHashMapRequest(FeedbackReceiver feedbackReceiver, java.lang.String receiverID, java.lang.String actionName)
          This method sends a request to an entity identified by the given receiverID to perform an action described by the actionName.
 java.lang.String sendHashMapRequest(FeedbackReceiver feedbackReceiver, java.lang.String receiverID, java.lang.String actionName, java.util.HashMap properties)
          This method sends a request to an entity identified by the given receiverID to perform an action described by the given String and a HashMap containing the action properties.
 java.lang.Object sendHashMapRequest(java.lang.String receiverID, java.lang.String actionName)
          This method sends a request described by the given actionName to perform by an entity identified by the receiverID.
 java.lang.Object sendHashMapRequest(java.lang.String receiverID, java.lang.String actionName, java.util.HashMap properties)
          This method sends a request described by actionName and a HashMap containing the action properties to perform an action by an entity identified by the receiverID.
 

Method Detail

sendHashMapRequest

java.lang.String sendHashMapRequest(FeedbackReceiver feedbackReceiver,
                                    java.lang.String receiverID,
                                    java.lang.String actionName,
                                    java.util.HashMap properties)
                                    throws ActionFailureException,
                                           NotLocatableException,
                                           TransportFailure
This method sends a request to an entity identified by the given receiverID to perform an action described by the given String and a HashMap containing the action 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 a 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 may 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 - when the request cannot be sent due to transport failure.

sendHashMapRequest

java.lang.String sendHashMapRequest(FeedbackReceiver feedbackReceiver,
                                    java.lang.String receiverID,
                                    java.lang.String actionName)
                                    throws ActionFailureException,
                                           NotLocatableException,
                                           TransportFailure
This method sends a request to an entity identified by the given receiverID to perform an action described by the actionName. 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.
Returns:
String containing the unique id of the requested action. This id may 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 - when the request cannot be sent due to transport failure.

sendHashMapRequest

java.lang.Object sendHashMapRequest(java.lang.String receiverID,
                                    java.lang.String actionName,
                                    java.util.HashMap properties)
                                    throws ActionFailureException,
                                           NotLocatableException,
                                           TransportFailure
This method sends a request described by actionName and a HashMap containing the action properties to perform an action by an entity identified by the receiverID. 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 ontological Strings representing the desired properties of the action and the associated values.
Returns:
Object containing the final result of the 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 - when the request cannot be sent due to transport failure.

sendHashMapRequest

java.lang.Object sendHashMapRequest(java.lang.String receiverID,
                                    java.lang.String actionName)
                                    throws ActionFailureException,
                                           NotLocatableException,
                                           TransportFailure
This method sends a request described by the given actionName to perform by an entity identified by the receiverID. 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.
Returns:
Object containing the final result of the 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 - when the request cannot be sent due to transport failure.


Copyright © 2005 IHMC All Rights Reserved.