DC_DummyRecoveryAction Class Reference

#include <DC_DummyRecoveryAction.h>

Inheritance diagram for DC_DummyRecoveryAction:

List of all members.

Detailed Description

Recovery action that performs no action and returns a configurable outcome (see setActionOutcome()).

This recovery action is used only for testing purposes.

Author:: Roberto Totaro

Version:: 1.0

Definition at line 23 of file DC_DummyRecoveryAction.h.

Public Member Functions

DC_DummyRecoveryAction (void)

Instantiate a dummy recovery action.

void setActionOutcome (TD_ActionOutcome nextOutcome)

Set the action's outcome.

void setExecutionFlag (bool canExecute)

Set the status of the execution flag.

Protected Member Functions

virtual TD_ActionOutcome doRecoveryAction (void)

Return actionOutcome without taking any action.

virtual bool canExecute (void)

Return actionCanExecute.

Constructor & Destructor Documentation

DC_DummyRecoveryAction::DC_DummyRecoveryAction ( void )

Instantiate a dummy recovery action.
The class identifier is set, actionOutcome is initialized to ACTION_SUCCESS and actionCanExecute to true.
Definition at line 16 of file DC_DummyRecoveryAction.cpp.

Member Function Documentation

bool DC_DummyRecoveryAction::canExecute ( void ) [protected, virtual]

Return actionCanExecute.

See also:
setExecutionFlag
RecoveryAction::doAction

Returns:
true if the action can be executed, false if the action cannot be executed.

Reimplemented from RecoveryAction.
Definition at line 26 of file DC_DummyRecoveryAction.cpp.

TD_ActionOutcome DC_DummyRecoveryAction::doRecoveryAction ( void ) [protected, virtual]

Return actionOutcome without taking any action.

See also:
setActionOutcome
RecoveryAction::doAction

Returns:
return the outcome code set by the caller

Implements RecoveryAction.
Definition at line 22 of file DC_DummyRecoveryAction.cpp.

void DC_DummyRecoveryAction::setActionOutcome ( TD_ActionOutcome nextOutcome )

Set the action's outcome.

See also:
doRecoveryAction

Parameters:

nextOutcome the outcome of the action

Definition at line 30 of file DC_DummyRecoveryAction.cpp.

void DC_DummyRecoveryAction::setExecutionFlag ( bool canExecute )

Set the status of the execution flag.

See also:
canExecute

Parameters:

canExecute the value returned by canExecute()

Definition at line 34 of file DC_DummyRecoveryAction.cpp.

The documentation for this class was generated from the following files:


Public Member Functions
	DC_DummyRecoveryAction (void)
	Instantiate a dummy recovery action.
void	setActionOutcome (TD_ActionOutcome nextOutcome)
	Set the action's outcome.
void	setExecutionFlag (bool canExecute)
	Set the status of the execution flag.
Protected Member Functions
virtual TD_ActionOutcome	doRecoveryAction (void)
	Return `actionOutcome` without taking any action.
virtual bool	canExecute (void)
	Return `actionCanExecute`.