kaos.core.csi.request
Interface AIDRequestManager

All Known Subinterfaces:

RequestManager

All Known Implementing Classes:

RequestManagerImpl

public interface AIDRequestManager

Defines the operations to send a request expressed by an ActionInstanceDescription to a given entity identified either by a unique guid or a KAoSEntityDescription.

Author:

KAoS Team

Method Summary

java.lang.String	sendAIDRequest(FeedbackReceiver feedbackReceiver, KAoSEntityDescription receiverDesc, ActionInstanceDescription aid) This method sends a request to an entity identified by the given receiverDesc to perform an action described by the given ActionInstanceDescription.
java.lang.String	sendAIDRequest(FeedbackReceiver feedbackReceiver, java.lang.String receiverID, ActionInstanceDescription aid) This method sends a request to an entity identified by the given receiverID to perform an action described by the given ActionInstanceDescription.
java.lang.Object	sendAIDRequest(KAoSEntityDescription receiverDesc, ActionInstanceDescription aid) This method sends a request described by an ActionInstanceDescription to perform an action by an entity identified by the KAoSEntityDescription.
java.lang.Object	sendAIDRequest(java.lang.String receiverID, ActionInstanceDescription aid) This method sends a request described by an ActionInstanceDescription to perform an action by an entity identified by the receiverID.

Method Detail

sendAIDRequest

java.lang.String sendAIDRequest(FeedbackReceiver feedbackReceiver,
                                java.lang.String receiverID,
                                ActionInstanceDescription aid)
                                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 ActionInstanceDescription. 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.

aid - is an ActionInstanceDescription 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 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.

sendAIDRequest

java.lang.String sendAIDRequest(FeedbackReceiver feedbackReceiver,
                                KAoSEntityDescription receiverDesc,
                                ActionInstanceDescription aid)
                                throws ActionFailureException,
                                       NotLocatableException,
                                       TransportFailure

This method sends a request to an entity identified by the given receiverDesc to perform an action described by the given ActionInstanceDescription. 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 a KAosEntityDescription of the entity, which is requested to perform the action.

aid - is an ActionInstanceDescription 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 may be used by the FeedbackReceiver to track the status of the 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.

sendAIDRequest

java.lang.Object sendAIDRequest(java.lang.String receiverID,
                                ActionInstanceDescription aid)
                                throws ActionFailureException,
                                       NotLocatableException,
                                       TransportFailure

This method sends a request described by an ActionInstanceDescription 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.

aid - is an ActionInstanceDescription that describes the action. It includes the action name and all action properties and their 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.

sendAIDRequest

java.lang.Object sendAIDRequest(KAoSEntityDescription receiverDesc,
                                ActionInstanceDescription aid)
                                throws ActionFailureException,
                                       NotLocatableException,
                                       TransportFailure

This method sends a request described by an ActionInstanceDescription to perform an action by an entity identified by the KAoSEntityDescription. The result is returned synchronously to the caller.

Parameters:

receiverDesc - is the KAoSEntityDescription that identifies the entity, which is requested to perform the action.

aid - is an ActionInstanceDescription that describes the action. It includes the action name and all action properties and their 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.