Back to index

plone3  3.1.7
Public Member Functions | Static Public Attributes
CMFDiffTool.interfaces.IDiffTool Class Reference
Inheritance diagram for CMFDiffTool.interfaces.IDiffTool:
Inheritance graph
[legend]
Collaboration diagram for CMFDiffTool.interfaces.IDiffTool:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def listDiffTypes
def setDiffForPortalType
def getDiffForPortalType
def computeDiff
def createChangeSet

Static Public Attributes

tuple id = Attribute('id','Must be set to "portal_diff"')

Detailed Description

An interface to compute object differences via pluggable
   difference engine

Definition at line 7 of file __init__.py.


Member Function Documentation

Compute the differences from ob1 to ob2 (ie. ob2 - ob1).

The result will be a list of objects that implements the
IDifference interface and represent the differences between
ob1 and ob2.

Definition at line 29 of file __init__.py.

00029 
00030     def computeDiff(ob1, ob2):
00031         """Compute the differences from ob1 to ob2 (ie. ob2 - ob1).
00032 
00033         The result will be a list of objects that implements the
00034         IDifference interface and represent the differences between
00035         ob1 and ob2."""

Returns a ChangeSet object that represents the differences
between ob1 and ob2 (ie. ob2 - ob1) .

Definition at line 36 of file __init__.py.

00036 
00037     def createChangeSet(ob1, ob2):
00038         """Returns a ChangeSet object that represents the differences
00039         between ob1 and ob2 (ie. ob2 - ob1) ."""
00040     
00041 

Returns a dictionary where each key is an attribute or
method on the given portal type, and the value is the name of
a difference type.

Definition at line 24 of file __init__.py.

00024 
00025     def getDiffForPortalType(pt_name):
00026         """Returns a dictionary where each key is an attribute or
00027         method on the given portal type, and the value is the name of
00028         a difference type."""
    
List the names of the available difference types

Definition at line 14 of file __init__.py.

00014 
00015     def listDiffTypes():
00016         """List the names of the available difference types"""

Set the difference type(s) for the specific portal type

mapping is a dictionary where each key is an attribute or
method on the given portal type, and the value is the name of
a difference type.

Definition at line 17 of file __init__.py.

00017 
00018     def setDiffForPortalType(pt_name, mapping):
00019         """Set the difference type(s) for the specific portal type
00020 
00021         mapping is a dictionary where each key is an attribute or
00022         method on the given portal type, and the value is the name of
00023         a difference type."""


Member Data Documentation

tuple CMFDiffTool.interfaces.IDiffTool.id = Attribute('id','Must be set to "portal_diff"') [static]

Definition at line 11 of file __init__.py.


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