kaos.core.csi.request
Interface AIDRequestReceiver

All Known Subinterfaces:

RequestReceiver

All Known Implementing Classes:

ActionMethodRequestHandler, DLIKImpl, RequestReceiverUsecase

public interface AIDRequestReceiver

Defines the operations to process a request expressed by an ActionInstanceDescription.

Author:

KAoS Team

Method Summary

java.lang.Object	processAIDRequest(ActionInstanceDescription aid) This method accepts a request described in an ActionInstanceDescription to perform an action.
void	processAIDRequest(ActionInstanceDescription aid, ActionStatusCallback statusCallback) This method accepts a request described by an ActionInstanceDescription to perform an action.

Method Detail

processAIDRequest

void processAIDRequest(ActionInstanceDescription aid,
                       ActionStatusCallback statusCallback)
                       throws ActionFailureException

This method accepts a request described by an ActionInstanceDescription to perform an action. Feedback from the action execution is sent to the requestor via the given ActionStatusCallback.

Parameters:

aid - is an ActionInstanceDescription that describes the action. It includes the action name and all action properties and their values.

statusCallback - ActionStatusCallback to be called to pass back to the action requestor information about progression of the action execution and the final result.

Throws:

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

processAIDRequest

java.lang.Object processAIDRequest(ActionInstanceDescription aid)
                                   throws ActionFailureException

This method accepts a request described in an ActionInstanceDescription to perform an action. The result is returned synchronously.

Parameters:

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