Package core :: Package controllers :: Module configurable :: Class configurable
[hide private]
[frames] | no frames]

Class configurable




This is mostly "an interface", this "interface" states that all classes that implement it, should implement the following methods :
  1. setOptions( OptionMap )
  2. getOptionsXML()



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

Instance Methods [hide private]
  getName(self)
  getOptionsXML(self)
This method returns a XML containing the Options that the configurable object has.
  getType(self)
  setOptions(self, OptionsMap)
Sets the Options given on the OptionsMap to self.

Method Details [hide private]

getName(self)

 
None

getOptionsXML(self)

 

This method returns a XML containing the Options that the configurable object has. Using this XML the framework will build a window, a menu, or some other input method to retrieve the info from the user. The XML has to validate against the xml schema file located at : w3af/core/display.xsd

This method MUST be implemented on every plugin.
Returns:
XML String

getType(self)

 
None

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 getOptionsXML()

This method MUST be implemented on every configurable object.
Returns:
No value is returned.