# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2002 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.
#
##############################################################################
"""
Products.ERP5.interfaces.coordinate
"""

from zope.interface import Interface

class ICoordinate(Interface):
  """
    Common Interface for all Coordinate objects
  """

  def asText():
    """
      returns the coordinate as a text string

    This method usually tries to lookup a skin named ${PortalType}_asText and
    to use this script to display the coordinate text.
    """
    pass

  def fromText(coordinate_text):
    """
      modifies the coordinate according to the input text.
    This method usually tries to lookup a skin named ${PortalType}_fromText and
    to use this script to modify the properties of this document.
    """
    pass

  def standardTextFormat():
    """
      returns a string which defines the standard
      string format for that coordinate
    """
    pass
