Back to index

plone3  3.1.7
Public Member Functions
GenericSetup.interfaces.IStepRegistry Class Reference
Inheritance diagram for GenericSetup.interfaces.IStepRegistry:
Inheritance graph
[legend]
Collaboration diagram for GenericSetup.interfaces.IStepRegistry:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def listSteps
def listStepMetadata
def getStepMetadata
def generateXML
def parseXML

Detailed Description

Base interface for step registries.

Definition at line 181 of file interfaces.py.


Member Function Documentation

Return a round-trippable XML representation of the registry.

o 'handler' values are serialized using their dotted names.

Definition at line 208 of file interfaces.py.

00208 
00209     def generateXML():
00210 
00211         """ Return a round-trippable XML representation of the registry.
00212 
00213         o 'handler' values are serialized using their dotted names.
00214         """

def GenericSetup.interfaces.IStepRegistry.getStepMetadata (   key,
  default = None 
)
Return a mapping of metadata for the step identified by 'key'.

o Return 'default' if no such step is registered.

o The 'handler' metadata is available via 'getStep'.

Definition at line 199 of file interfaces.py.

00199 
00200     def getStepMetadata( key, default=None ):
00201 
00202         """ Return a mapping of metadata for the step identified by 'key'.
00203 
00204         o Return 'default' if no such step is registered.
00205 
00206         o The 'handler' metadata is available via 'getStep'.
00207         """

Here is the caller graph for this function:

Return a sequence of mappings describing registered steps.

o Mappings will be ordered alphabetically.

Definition at line 192 of file interfaces.py.

00192 
00193     def listStepMetadata():
00194 
00195         """ Return a sequence of mappings describing registered steps.
00196 
00197         o Mappings will be ordered alphabetically.
00198         """

Base interface for step registries.
Return a sequence of IDs of registered steps.

o Order is not significant.

Definition at line 185 of file interfaces.py.

00185 
00186     def listSteps():
00187 
00188         """ Return a sequence of IDs of registered steps.
00189 
00190         o Order is not significant.
00191         """

Here is the caller graph for this function:

Parse 'text'.

Definition at line 215 of file interfaces.py.

00215 
00216     def parseXML( text ):
00217 
00218         """ Parse 'text'.
00219         """

Here is the caller graph for this function:


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