Package flumotion :: Package wizard :: Module scenarios :: Class Scenario
[hide private]

Class Scenario

source code

object --+
         |
        Scenario
Known Subclasses:

Base class for Scenarios

A scenario decides the following:

 - Which steps should be shown
 - How the configuration for the steps should be saved
Instance Methods [hide private]
 
__init__(self, wizard)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
WizardSaver
getSaver(self)
Returns a wizard saver that should be used to save the configuration generated to be created by this scenario.
source code
 
setExistingComponentNames(self, componentNames)
Tells the scenario about the existing components available, so we can resolve naming conflicts when saving the configuration
source code
 
addSteps(self)
Add the wizard section steps specific for this scenario
source code
WizardSaver
save(self)
Save the content of the wizard Can be overridden in a subclass
source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, wizard)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

getSaver(self)

source code 

Returns a wizard saver that should be used to save the configuration generated to be created by this scenario.

Returns: WizardSaver
the wizard saver

setExistingComponentNames(self, componentNames)

source code 

Tells the scenario about the existing components available, so we can resolve naming conflicts when saving the configuration

Parameters:
  • componentNames (list of strings) - existing component names

save(self)

source code 

Save the content of the wizard Can be overridden in a subclass

Returns: WizardSaver
wizard saver