FourMS
Interface iActionFinishedListenerInterface

public interface iActionFinishedListenerInterface

This class describes a interface which should be implemented by any class which initiates a subaction upon a mechanism. The FourMS package will be used to inform the initiator that the action has been completed.

Method Summary

java.lang.Void

subActionCompleted(java.lang.Integer SubActionCompletedState, java.lang.String SubActionErrorReport, java.lang.String SubActionName, java.lang.Integer ErrorCode, java.lang.String MechanismName) Used to callback a object that initiated subaction on a mechanism.

Method Detail

subActionCompleted

java.lang.Void subActionCompleted(java.lang.Integer SubActionCompletedState,
                                  java.lang.String SubActionErrorReport,
                                  java.lang.String SubActionName,
                                  java.lang.Integer ErrorCode,
                                  java.lang.String MechanismName)

Used to callback a object that initiated subaction on a mechanism. The callback will be called when the subaction completes for ANY reason. This might be that the action completes successfully, it fails or times out.

Parameters:

SubActionCompletedState - - This represents the state that the subaction was in when it completed. SUBACTIONFAILED SUBACTIONTIMEDOUT SUBACTIONCOMPLETEDOK

SubActionErrorReport - - This is any text associated with any failure of the subaction to complete.

SubActionName - - This is the name of the subaction that has just finished.

ErrorCode - - This is an integer error code which is returned to the subaction initiator in the event that the subaction did not complete successfully. If the subaction completed correctly then the value of this parameter is undefined.

MechanismName - - This is the mechanism associated with the subaction. It provides context when the action has finished.

Returns:

Void