kaos.core.csi.request
Interface ObligationRequestManager

All Known Subinterfaces:

RequestManager

public interface ObligationRequestManager

Defines the operations to send an obligation request described by an obligation ActionInstanceDescription and trigger ActionInstanceDescription to an entity for execution. The entity is identified either by a unique ID or a KAoSEntityDescription.

Author:

KAoS team

Method Summary

void	sendObligationRequest(kaos.core.service.directory.KAoSEntityDescription receiverDesc, ActionInstanceDescription obligationAID, ActionInstanceDescription triggerAID) This method sends an obligation request to an entity identified by the given receiverDesc to execute an obligation action described by the given obligation ActionInstanceDescription and the trigger ActionInstanceDescription.
void	sendObligationRequest(java.lang.String receiverID, ActionInstanceDescription obligationAID, ActionInstanceDescription triggerAID) This method sends an obligation request to an entity identified by its unique ID to execute an obligation action described by the given obligation ActionInstanceDescription and the trigger ActionInstanceDescription.

Method Detail

sendObligationRequest

void sendObligationRequest(kaos.core.service.directory.KAoSEntityDescription receiverDesc,
                           ActionInstanceDescription obligationAID,
                           ActionInstanceDescription triggerAID)
                           throws ActionFailureException,
                                  NotLocatableException,
                                  TransportFailure

This method sends an obligation request to an entity identified by the given receiverDesc to execute an obligation action described by the given obligation ActionInstanceDescription and the trigger ActionInstanceDescription.

Parameters:

receiverDesc - is a KAosEntityDescription of the entity, which is requested to execute the obligation request.

obligationAID - is an ActionInstanceDescription containing the obligation action name and its properties.

triggerAID - is an ActionInstanceDescription containing the trigger action name and its properties.

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.

sendObligationRequest

void sendObligationRequest(java.lang.String receiverID,
                           ActionInstanceDescription obligationAID,
                           ActionInstanceDescription triggerAID)
                           throws ActionFailureException,
                                  NotLocatableException,
                                  TransportFailure

This method sends an obligation request to an entity identified by its unique ID to execute an obligation action described by the given obligation ActionInstanceDescription and the trigger ActionInstanceDescription.

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.

obligationAID - is an ActionInstanceDescription containing the obligation action name and its properties.

triggerAID - is an ActionInstanceDescription containing the trigger action name and its properties.

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.