expandable.py 1.97 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1
# -*- coding: utf-8 -*-
2 3
##############################################################################
#
4
# Copyright (c) 2012 Nexedi SA and Contributors. All Rights Reserved.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################
28 29 30
"""
Products.ERP5.interfaces.expandable
"""
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31
from zope.interface import Interface
32

33
class IExpandable(Interface):
34
  """Common Interface for Applied Rules and Simulation Movements
35
  """
36
  def expand(expand_policy=None, activate_kw=None):
37
    """
38 39 40 41 42
    Update subobjects of this document and expand them

    expand_policy -- string defining whether a node in the simulation tree
                     should be expand immediately or in a separate activity,
                     or None to use the preferred policy
Jean-Paul Smets's avatar
Jean-Paul Smets committed
43

44 45
    activate_kw -- activity parameters, required to control
                   activity constraints
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46

47
    Available policies: immediate, deferred, vertical_time_bound
48
    """