kaos.core.csi.request
Interface HashMapRequestReceiver

All Known Subinterfaces:

RequestReceiver

All Known Implementing Classes:

ActionMethodRequestHandler, RequestReceiverUsecase

public interface HashMapRequestReceiver

Defines the operations to process a request expressed by a name and a HashMap of properties.

Author:

KAoS Team

Method Summary

java.lang.Object	processHashMapRequest(java.lang.String actionName) This method accepts a request described by the given String containing action name.
void	processHashMapRequest(java.lang.String actionName, kaos.core.service.ontology.request.ActionStatusCallback statusCallback) This method accepts a request described by the given String containing the action name.
java.lang.Object	processHashMapRequest(java.lang.String actionName, java.util.HashMap properties) This method accepts a request described by the given String containing action name and HashMap of properties.
void	processHashMapRequest(java.lang.String actionName, java.util.HashMap properties, kaos.core.service.ontology.request.ActionStatusCallback statusCallback) This method accepts a request described by the given String containing action name and HashMap of properties.

Method Detail

processHashMapRequest

void processHashMapRequest(java.lang.String actionName,
                           java.util.HashMap properties,
                           kaos.core.service.ontology.request.ActionStatusCallback statusCallback)
                           throws ActionFailureException

This method accepts a request described by the given String containing action name and HashMap of properties. Feedback from the action execution is sent to the requestor via the given ActionStatusCallback.

Parameters:

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.

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

processHashMapRequest

void processHashMapRequest(java.lang.String actionName,
                           kaos.core.service.ontology.request.ActionStatusCallback statusCallback)
                           throws ActionFailureException

This method accepts a request described by the given String containing the action name. Feedback from the action execution is sent to the requestor via the given ActionStatusCallback.

Parameters:

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

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

processHashMapRequest

java.lang.Object processHashMapRequest(java.lang.String actionName,
                                       java.util.HashMap properties)
                                       throws ActionFailureException

This method accepts a request described by the given String containing action name and HashMap of properties. The result is returned synchronously.

Parameters:

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:

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

processHashMapRequest

java.lang.Object processHashMapRequest(java.lang.String actionName)
                                       throws ActionFailureException

This method accepts a request described by the given String containing action name. The result is returned synchronously.

Parameters:

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