kaos.core.csi.request
Interface OWLRequestManager

All Known Subinterfaces:

RequestManager

All Known Implementing Classes:

RequestManagerImpl

public interface OWLRequestManager

Defines the operations to send a request expressed by an OWL String.

Method Summary

java.lang.String	sendOWLRequest(FeedbackReceiver feedbackReceiver, KAoSEntityDescription receiverDesc, java.lang.String owlActionDescription) This method sends a request 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	sendOWLRequest(FeedbackReceiver feedbackReceiver, java.lang.String receiverID, java.lang.String owlActionDescription) This method sends a request 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.Object	sendOWLRequest(KAoSEntityDescription receiverDesc, java.lang.String owlActionDescription) This method sends a request described by an OWL String to perform an action by an entity identified by the KAoSEntityDescription.
java.lang.Object	sendOWLRequest(java.lang.String receiverID, java.lang.String owlActionDescription) This method sends a request described by an OWL String to perform an action by an entity identified by the receiverID.

Method Detail

sendOWLRequest

java.lang.String sendOWLRequest(FeedbackReceiver feedbackReceiver,
                                java.lang.String receiverID,
                                java.lang.String owlActionDescription)
                                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, 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 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.

sendOWLRequest

java.lang.String sendOWLRequest(FeedbackReceiver feedbackReceiver,
                                KAoSEntityDescription receiverDesc,
                                java.lang.String owlActionDescription)
                                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 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 a 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 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.

sendOWLRequest

java.lang.Object sendOWLRequest(java.lang.String receiverID,
                                java.lang.String owlActionDescription)
                                throws ActionFailureException,
                                       NotLocatableException,
                                       TransportFailure

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

owlActionDescription - is an OWL String 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.

sendOWLRequest

java.lang.Object sendOWLRequest(KAoSEntityDescription receiverDesc,
                                java.lang.String owlActionDescription)
                                throws ActionFailureException,
                                       NotLocatableException,
                                       TransportFailure

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

owlActionDescription - is an OWL String 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.