Back to index

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

List of all members.

Public Member Functions

def writeDataFile
def getSite
def getSetupTool
def getEncoding
def listNotes
def clearNotes
def getLogger
def shouldPurge

Detailed Description

Definition at line 150 of file interfaces.py.


Member Function Documentation

Clear all notes recorded by this context.

Definition at line 77 of file interfaces.py.

00077 
00078     def clearNotes():
00079         """ Clear all notes recorded by this context.
00080         """

Get the encoding used for configuration data within the site.

o Return None if the data should not be encoded.

Definition at line 64 of file interfaces.py.

00064 
00065     def getEncoding():
00066 
00067         """ Get the encoding used for configuration data within the site.
00068 
00069         o Return None if the data should not be encoded.
00070         """

Here is the caller graph for this function:

Get a logger with the specified name, creating it if necessary.

Definition at line 41 of file interfaces.py.

00041 
00042     def getLogger(name):
00043         """Get a logger with the specified name, creating it if necessary.
00044         """

Return the site object being configured / dumped.

Definition at line 59 of file interfaces.py.

00059 
00060     def getSetupTool():
00061 
00062         """ Return the site object being configured / dumped.
00063         """

Context used for export / import plugins.
Return the site object being configured / dumped.

Definition at line 54 of file interfaces.py.

00054 
00055     def getSite():
00056 
00057         """ Return the site object being configured / dumped.
00058         """

Return notes recorded by this context.

o Result a sequence of (component, message) tuples

Definition at line 71 of file interfaces.py.

00071 
00072     def listNotes():
00073         """ Return notes recorded by this context.
00074         
00075         o Result a sequence of (component, message) tuples
00076         """

When installing, should the existing setup be purged?

Definition at line 45 of file interfaces.py.

00045 
00046     def shouldPurge():
00047         """When installing, should the existing setup be purged?
00048         """
00049 

def GenericSetup.interfaces.IExportContext.writeDataFile (   filename,
  text,
  content_type,
  subdir = None 
)
Write data into the specified location.

o 'filename' is the unqualified name of the file.

o 'text' is the content of the file.

o 'content_type' is the MIMEtype of the file.

o 'subdir', if passed, is a path to a subdirectory / folder in
  which to write the file;  if not passed, write the file to the
  "root" of the target.

Definition at line 152 of file interfaces.py.

00152 
00153     def writeDataFile( filename, text, content_type, subdir=None ):
00154 
00155         """ Write data into the specified location.
00156 
00157         o 'filename' is the unqualified name of the file.
00158 
00159         o 'text' is the content of the file.
00160 
00161         o 'content_type' is the MIMEtype of the file.
00162 
00163         o 'subdir', if passed, is a path to a subdirectory / folder in
00164           which to write the file;  if not passed, write the file to the
00165           "root" of the target.
00166         """


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