# (C) Copyright 2006 Nuxeo SAS <http://nuxeo.com>
# Author: Julien Anguenot <ja@nuxeo.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as published
# by the Free Software Foundation.
#
# 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.
#
# $Id$
"""CPS Lucene Catalog interface
"""

import zope.interface
import zope.schema

from zope.app.i18n import ZopeMessageFactory as _

from Products.CMFCore.interfaces import ICatalogTool

class ICPSLuceneCatalogTool(ICatalogTool):
    """CPS Lucene catalog Tool
    """

    server_url = zope.schema.TextLine(
        title=_(u"Server URL"),
        description=_(u"XML-RPC server URL"),
        required=True,
        default=u'http://localhost',
        )

    server_port = zope.schema.Int(
        title=_(u"Server port"),
        description=_(u"XML-RPC server port"),
        required=True,
        default=9180,
        )

    def clean():
        """Clean the whole indexes store.

        This will remove *all* the indexes from the store.
        """

class IZCatalogQuery(zope.interface.Interface):
    """ZCatalog Query
    """

    def getFieldsMap():
        """Returns a field -> value mapping
        """

    def getOptionsMap():
        """Return a option id -> value mapping

        It includes batches information and / or sorting parameters.
        """

class ICPSBrain(zope.interface.Interface):
    """Lite Catalog brain class for CPS
    """

    def has_key():
        """
        """

    def getPath():
        """Get the physical path for this record
        """

    def getURL(relative=0):
        """Generate a URL for this record
        """

    def getObject(REQUEST=None):
        """Return the object for this record

        Will return None if the object cannot be found via its cataloged path
        (i.e., it was deleted or moved without recataloging), or if the user is
        not authorized to access the object.

        This method mimicks a subset of what publisher's traversal does,
        so it allows access if the final object can be accessed even
        if intermediate objects cannot.
        """

    def getRID(self):
        """Return the record ID for this object.
        """