# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2009 Nexedi SARL and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
#
# 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.
#
##############################################################################

from zope.interface import Interface

class IPropertyRecordable(Interface):
  """Property Recordable interface specification

  IPropertyRecordable provides methods to record
  existing properties of a document and later retrieve
  them. It is used by simulation to record forced
  properties on simulation movements, but could be used
  for other purpose.

  TODO:
    - extend interface to support time (getRecordedPropertyList)
  """

  def recordProperty(id):
    """
    Records the current value of a property.

    id -- ID of the property
    """

  def clearRecordedProperty(id):
    """
    Clears a previously recorded property from
    the property record.
    """

  def getRecordedPropertyIdList():
    """
    Returns the list of property IDs which have
    been recorded.
    """

  def isPropertyRecorded(id):
    """
    Returns True if property with given ID has been
    previously recorded, False else.

    id -- ID of the property
    """

  def getRecordedProperty(id):
    """
    Returns recorded value of property with given ID

    id -- ID of the property
    """

  def asRecordedContext():
    """
    Returns current document as a temp document
    which recorded properties in its context.
    """
