Back to index

plone3  3.1.7
IVersionPolicy.py
Go to the documentation of this file.
00001 #########################################################################
00002 # Copyright (c) 2004, 2005 Alberto Berti, Gregoire Weber.
00003 # All Rights Reserved.
00004 #
00005 # This file is part of CMFEditions.
00006 #
00007 # CMFEditions is free software; you can redistribute it and/or modify
00008 # it under the terms of the GNU General Public License as published by
00009 # the Free Software Foundation; either version 2 of the License, or
00010 # (at your option) any later version.
00011 #
00012 # CMFEditions is distributed in the hope that it will be useful,
00013 # but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015 # GNU General Public License for more details.
00016 #
00017 # You should have received a copy of the GNU General Public License
00018 # along with CMFEditions; if not, write to the Free Software
00019 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
00020 #########################################################################
00021 """Version Policies
00022 $Id$
00023 """
00024 from Interface import Interface
00025 
00026 
00027 class IVersionPolicy(Interface):
00028     """A version policy object, which describes and sets up a versioning
00029        policy
00030     """
00031 
00032     def Title():
00033         """Returns a nice name for the policy"""
00034 
00035     # Some optional hooks used to set up the policy if available
00036     # these will be called when the corresponding action is taken in
00037     # portal_repository.  Make sure these take keyword arguments as some
00038     # may be passed on manage_changePolicyDefs or manage_setTypePolicies.
00039 
00040     # def setupPolicyHook(portal, **kw)
00041     #     """Performs setup actions when a policy is added to a portal"""
00042 
00043     # def removePolicyHook(portal, **kw)
00044     #     """Performs teardown actions when a policy is added to a portal"""
00045 
00046     # def enablePolicyOnTypeHook(portal, type, **kw)
00047     #     """Performs setup actions when a policy is enabled on a type"""
00048 
00049     # def disablePolicyOnTypeHook(portal, type, **kw)
00050     #     """Performs teardown actions when a policy is enabled on a type"""