Back to index

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

List of all members.

Public Member Functions

def readDataFile
def getLastModified
def isDirectory
def listDirectory
def getSite
def getSetupTool
def getEncoding
def listNotes
def clearNotes
def getLogger
def shouldPurge

Detailed Description

Definition at line 81 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:

Return the modification timestamp of the item at 'path'.

o Result will be a DateTime instance.

o Search profiles in the configuration in order.

o If the context is filesystem based, return the 'stat' timestamp
  of the file / directory to which 'path' points.

o If the context is ZODB-based, return the Zope modification time
  of the object to which 'path' points.

o Return None if 'path' does not point to any object.

Definition at line 96 of file interfaces.py.

00096 
00097     def getLastModified( path ):
00098 
00099         """ Return the modification timestamp of the item at 'path'.
00100 
00101         o Result will be a DateTime instance.
00102 
00103         o Search profiles in the configuration in order.
00104 
00105         o If the context is filesystem based, return the 'stat' timestamp
00106           of the file / directory to which 'path' points.
00107 
00108         o If the context is ZODB-based, return the Zope modification time
00109           of the object to which 'path' points.
00110 
00111         o Return None if 'path' does not point to any object.
00112         """

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         """

Test whether path points to a directory / folder.

o If the context is filesystem based, check that 'path' points to
  a subdirectory within the "root" directory.

o If the context is ZODB-based, check that 'path' points to a
  "container" under the context's tool.

o Return None if 'path' does not resolve;  otherwise, return a
  bool.

Definition at line 113 of file interfaces.py.

00113 
00114     def isDirectory( path ):
00115 
00116         """ Test whether path points to a directory / folder.
00117 
00118         o If the context is filesystem based, check that 'path' points to
00119           a subdirectory within the "root" directory.
00120 
00121         o If the context is ZODB-based, check that 'path' points to a
00122           "container" under the context's tool.
00123 
00124         o Return None if 'path' does not resolve;  otherwise, return a
00125           bool.
00126         """

List IDs of the contents of a  directory / folder.

o Omit names in 'skip'.

o If 'path' does not point to a directory / folder, return None.

Definition at line 127 of file interfaces.py.

00127 
00128     def listDirectory( path, skip=SKIPPED_FILES ):
00129 
00130         """ List IDs of the contents of a  directory / folder.
00131 
00132         o Omit names in 'skip'.
00133 
00134         o If 'path' does not point to a directory / folder, return None.
00135         """
00136 

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         """

def GenericSetup.interfaces.IImportContext.readDataFile (   filename,
  subdir = None 
)
Search the current configuration for the requested file.

o 'filename' is the name (without path elements) of the file.

o 'subdir' is an optional subdirectory;  if not supplied, search
  only the "root" directory.

o Return the file contents as a string, or None if the
  file cannot be found.

Definition at line 83 of file interfaces.py.

00083 
00084     def readDataFile( filename, subdir=None ):
00085 
00086         """ Search the current configuration for the requested file.
00087 
00088         o 'filename' is the name (without path elements) of the file.
00089 
00090         o 'subdir' is an optional subdirectory;  if not supplied, search
00091           only the "root" directory.
00092 
00093         o Return the file contents as a string, or None if the
00094           file cannot be found.
00095         """

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 


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