##############################################################################
#
# Copyright (c) 2009 Nexedi SA and Contributors. All Rights Reserved.
#          Fabien Morin <fabien@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 Products.ERP5Type.Constraint import Constraint
translateString = lambda msg, **kw: msg # just to extract messages
_MARKER = []


class TradeModelLineCellConsistency(Constraint):
  """
  This constraint checks if the Trade Model Line should contain cells (if
  variation categories are defined on it)
  """

  _message_id_list = [ 'message_cell_inexistance',]
  message_cell_inexistance = translateString(
      'Missing cells on line "${line}"')

  def checkConsistency(self, document, fixit=0):
    """
      Implement here the consistency checker
    """
    error_list = []
    base_id = self.constraint_definition['base_id']
    for cell_coordinates in document.getCellKeyList(base_id=base_id):
      if document.getCell(base_id=base_id, *cell_coordinates) is None:
        error_list.append(self._generateError(document,
          self._getMessage('message_cell_inexistance'),
          mapping=dict(line=document.getTitle())))
        return error_list

    return error_list