Package core :: Package controllers :: Module configurable :: Class configurable

Class configurable

This is mostly "an interface", this "interface" states that all classes that implement it, should implement the following methods :

setOptions( optionsMap )
getOptions()

Author: Andres Riancho ( andres.riancho@gmail.com )

Instance Methods

[hide private]

getName(self)

getOptions(self)
This method returns an optionList containing the options objects that the configurable object has.

getType(self)

setOptions(self, optionsMap)
Sets the Options given on the optionsMap to self.

Method Details

[hide private]

getOptions(self)

This method returns an optionList containing the options objects that the configurable object has. Using this option list the framework will build a window, a menu, or some other input method to retrieve the info from the user.

This method MUST be implemented on every plugin.

Returns:: optionList object.

setOptions(self, optionsMap)

Sets the Options given on the optionsMap to self. The options are the result of a user entering some data on a window that was constructed using the XML Options that was retrieved from the plugin using getOptions()

This method MUST be implemented on every configurable object.

Returns:: No value is returned.