kaos.core.csi.request
Interface FeedbackReceiver

All Known Implementing Classes:

BLIKCmdRobotSearch, BLIKCommandExample, BLIKObserverCmd, BreveBot, CSIFeedbackReceiverExample, ER1, Kaa, KAoSPlayer, KAoSRobot, KAoSRobotTest, KBot, RequestManagerImpl, RequestSenderUsecase, RobotClient, StubBot, XMLToCSILink

public interface FeedbackReceiver

Author:

KAoS Team $Revision: 1.1 $

Method Summary

void	onAborted(java.util.Calendar time, java.lang.Object reason, java.lang.String actionID, java.lang.String robotID) This method is invoked when the requested action is aborted.
void	onAccepted(java.util.Calendar time, java.lang.Object acceptInfo, java.lang.String actionID, java.lang.String robotID) This method is invoked when the request is accepted by the robot.
void	onCompleted(java.util.Calendar time, java.lang.Object result, java.lang.String actionID, java.lang.String robotID) This method is invoked upon completion of the request byt the requested robot.
void	onRefused(java.util.Calendar time, java.lang.Object reason, java.lang.String actionID, java.lang.String robotID) This method is invoked when the request is refused by the robot.
void	onStarted(java.util.Calendar time, java.lang.Object startedInfo, java.lang.String actionID, java.lang.String robotID) This method is invoked when the robot starts the requested action.
void	receiveKAoSStatus(java.lang.String statusMsg, java.lang.String actionID, java.lang.String robotID) Receive a status message describing the execution of the requested action.

Method Detail

onAccepted

void onAccepted(java.util.Calendar time,
                java.lang.Object acceptInfo,
                java.lang.String actionID,
                java.lang.String robotID)

This method is invoked when the request is accepted by the robot.

Parameters:

time - Calendar time of acceptance.

acceptInfo - Object containing additional (optional) info about the acceptance.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

onRefused

void onRefused(java.util.Calendar time,
               java.lang.Object reason,
               java.lang.String actionID,
               java.lang.String robotID)

This method is invoked when the request is refused by the robot.

Parameters:

time - Calendar time of refusal.

reason - Object containing the reason for refusing the request.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

onCompleted

void onCompleted(java.util.Calendar time,
                 java.lang.Object result,
                 java.lang.String actionID,
                 java.lang.String robotID)

This method is invoked upon completion of the request byt the requested robot.

Parameters:

time - Calendar time of information/action completion.

result - Object containing the result of the requested action.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

onStarted

void onStarted(java.util.Calendar time,
               java.lang.Object startedInfo,
               java.lang.String actionID,
               java.lang.String robotID)

This method is invoked when the robot starts the requested action.

Parameters:

time - Calendar time of starting an action.

startedInfo - Object containing additional (optional) info about the start of the action.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

onAborted

void onAborted(java.util.Calendar time,
               java.lang.Object reason,
               java.lang.String actionID,
               java.lang.String robotID)

This method is invoked when the requested action is aborted.

Parameters:

time - Calendar time of aborting an action.

reason - Object containing the reason for aborting an action.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

receiveKAoSStatus

void receiveKAoSStatus(java.lang.String statusMsg,
                       java.lang.String actionID,
                       java.lang.String robotID)

Receive a status message describing the execution of the requested action. There maybe several status messages sent during action execution.

Parameters:

statusMsg - Object containing the result of the requested action/information.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.