API Documentation

Classes

IndexableObjectWrapper , portal_catalog

Catalog tool interface.

$Id: portal_catalog.py,v 1.7 2003/01/06 20:38:30 yuppie Exp $


class IndexableObjectWrapper

Indexable object wrapper interface.


Methods

allowedRolesAndUsers():

Return a list of roles and users with View permission. Used by PortalCatalog to filter out items you're not allowed to see.


class portal_catalog

This tool interacts with a customized ZCatalog.


id = Must be set to "portal_catalog"

Methods

searchResults(REQUEST=None, **kw):

Calls SiteIndex.searchResults() with extra arguments that limit the results to what the user is allowed to see.

getpath(data_record_id_):

Calls ZCatalog.getpath().

indexObject(object):

Add to catalog.

__call__(REQUEST=None, **kw):

Same as searchResults().

reindexObject(object, idxs=[]):

Update entry in catalog. The optional idxs argument is a list of specific indexes to update (all of them by default).

unindexObject(object):

Remove from catalog.