Back to index

plone3  3.1.7
Public Member Functions | Static Public Attributes
CMFCore.interfaces._tools.ICatalogTool Class Reference
Inheritance diagram for CMFCore.interfaces._tools.ICatalogTool:
Inheritance graph
[legend]
Collaboration diagram for CMFCore.interfaces._tools.ICatalogTool:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def searchResults
def __call__
def unrestrictedSearchResults
def indexObject
def unindexObject
def reindexObject

Static Public Attributes

tuple id = Attribute('id', 'Must be set to "portal_catalog"')

Detailed Description

Wrap the "stock" ZCatalog with custom behavior for the CMF.

Definition at line 343 of file _tools.py.


Member Function Documentation

def CMFCore.interfaces._tools.ICatalogTool.__call__ (   REQUEST = None,
  kw 
)
Alias for searchResults().

Definition at line 359 of file _tools.py.

00359 
00360     def __call__(REQUEST=None, **kw):
00361         """Alias for searchResults().
00362         """

Here is the caller graph for this function:

Add 'object' to the catalog.

o Permission:  Private (Python only)

Definition at line 369 of file _tools.py.

00369 
00370     def indexObject(object):
00371         """ Add 'object' to the catalog.
00372 
00373         o Permission:  Private (Python only)
00374         """

def CMFCore.interfaces._tools.ICatalogTool.reindexObject (   object,
  idxs = [],
  update_metadata = True 
)
Update 'object' in catalog.

o 'idxs', if passed, is a list of specific indexes to update
  (by default, all indexes are updated).

o If 'update_metadata' is True, then update the metadata record
  in the catalog as well.

o Permission:  Private (Python only)

Definition at line 381 of file _tools.py.

00381 
00382     def reindexObject(object, idxs=[], update_metadata=True):
00383         """ Update 'object' in catalog.
00384 
00385         o 'idxs', if passed, is a list of specific indexes to update
00386           (by default, all indexes are updated).
00387 
00388         o If 'update_metadata' is True, then update the metadata record
00389           in the catalog as well.
00390 
00391         o Permission:  Private (Python only)
00392         """
00393 

Here is the caller graph for this function:

def CMFCore.interfaces._tools.ICatalogTool.searchResults (   REQUEST = None,
  kw 
)
Decorate ZCatalog.searchResults() with extra arguments

o The extra arguments that the results to what the user would be
  allowed to see.

Definition at line 351 of file _tools.py.

00351 
00352     def searchResults(REQUEST=None, **kw):
00353         """ Decorate ZCatalog.searchResults() with extra arguments
00354 
00355         o The extra arguments that the results to what the user would be
00356           allowed to see.
00357         """

Here is the caller graph for this function:

Remove 'object' from the catalog.

o Permission:  Private (Python only)

Definition at line 375 of file _tools.py.

00375 
00376     def unindexObject(object):
00377         """ Remove 'object' from the catalog.
00378 
00379         o Permission:  Private (Python only)
00380         """

Calls ZCatalog.searchResults() without any CMF-specific processing.

o Permission:  Private (Python only)

Definition at line 363 of file _tools.py.

00363 
00364     def unrestrictedSearchResults(REQUEST=None, **kw):
00365         """Calls ZCatalog.searchResults() without any CMF-specific processing.
00366 
00367         o Permission:  Private (Python only)
00368         """


Member Data Documentation

tuple CMFCore.interfaces._tools.ICatalogTool.id = Attribute('id', 'Must be set to "portal_catalog"') [static]
Wrap the "stock" ZCatalog with custom behavior for the CMF.

Definition at line 348 of file _tools.py.


The documentation for this class was generated from the following file: