Back to index

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

List of all members.

Public Member Functions

def export
def listExportableItems

Detailed Description

Plugin interface for site structure export.

Definition at line 713 of file interfaces.py.


Member Function Documentation

def GenericSetup.interfaces.IFilesystemExporter.export (   export_context,
  subdir,
  root = False 
)
Plugin interface for site structure export.
Export our 'context' using the API of 'export_context'.

o 'export_context' must implement
  Products.GenericSupport.interfaces.IExportContext.

o 'subdir', if passed, is the relative subdirectory containing our
  context within the site.

o 'root', if true, indicates that the current context is the
  "root" of an import (this may be used to adjust paths when
  interacting with the context).

Definition at line 716 of file interfaces.py.

00716 
00717     def export(export_context, subdir, root=False):
00718         """ Export our 'context' using the API of 'export_context'.
00719 
00720         o 'export_context' must implement
00721           Products.GenericSupport.interfaces.IExportContext.
00722 
00723         o 'subdir', if passed, is the relative subdirectory containing our
00724           context within the site.
00725 
00726         o 'root', if true, indicates that the current context is the
00727           "root" of an import (this may be used to adjust paths when
00728           interacting with the context).
00729         """

Return a sequence of the child items to be exported.

o Each item in the returned sequence will be a tuple,
  (id, object, adapter) where adapter must implement
  IFilesystemExporter.

Definition at line 730 of file interfaces.py.

00730 
00731     def listExportableItems():
00732         """ Return a sequence of the child items to be exported.
00733 
00734         o Each item in the returned sequence will be a tuple,
00735           (id, object, adapter) where adapter must implement
00736           IFilesystemExporter.
00737         """


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