Back to index

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

List of all members.

Public Member Functions

def getStep
def registerStep
def listSteps
def listStepMetadata
def getStepMetadata
def generateXML
def parseXML

Detailed Description

API for export step registry.

Definition at line 283 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.IExportStepRegistry.getStep (   key,
  default = None 
)
API for export step registry.
Return the IExportPlugin registered for 'key'.

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

Definition at line 287 of file interfaces.py.

00287 
00288     def getStep( key, default=None ):
00289 
00290         """ Return the IExportPlugin registered for 'key'.
00291 
00292         o Return 'default' if no such step is registered.
00293         """

def GenericSetup.interfaces.IStepRegistry.getStepMetadata (   key,
  default = None 
) [inherited]
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:

def GenericSetup.interfaces.IExportStepRegistry.registerStep (   id,
  handler,
  title = None,
  description = None 
)
Register an export step.

o 'id' is the unique identifier for this step

o 'handler' should implement IExportPlugin.

o 'title' is a one-line UI description for this step.
  If None, the first line of the documentation string of the step
  is used, or the id if no docstring can be found.

o 'description' is a one-line UI description for this step.
  If None, the remaining line of the documentation string of
  the step is used, or default to ''.

Definition at line 294 of file interfaces.py.

00294 
00295     def registerStep( id, handler, title=None, description=None ):
00296 
00297         """ Register an export step.
00298 
00299         o 'id' is the unique identifier for this step
00300 
00301         o 'handler' should implement IExportPlugin.
00302 
00303         o 'title' is a one-line UI description for this step.
00304           If None, the first line of the documentation string of the step
00305           is used, or the id if no docstring can be found.
00306 
00307         o 'description' is a one-line UI description for this step.
00308           If None, the remaining line of the documentation string of
00309           the step is used, or default to ''.
00310         """


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