Skip to content

Commit

Permalink
Documented two features of the catalog:
Browse files Browse the repository at this point in the history
- You can pass the list of indexes to update to catalog_object().

- uids can be relative rather than absolute.
  • Loading branch information
hathawsh committed Sep 5, 2002
1 parent 19be24a commit 3b3b1ef
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions IZCatalog.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
#
##############################################################################
"""
$Id: IZCatalog.py,v 1.3 2002/08/14 22:25:15 mj Exp $
$Id: IZCatalog.py,v 1.4 2002/09/05 21:22:39 shane Exp $
"""

from Interface import Interface
Expand Down Expand Up @@ -66,16 +66,20 @@ class IZCatalog(Interface):
"""

def catalog_object(obj, uid):
def catalog_object(obj, uid, idxs=[]):
"""Catalogs the object 'obj' with the unique identifier 'uid'.
The uid must be a physical path!
The uid must be a physical path, either absolute or relative to
the catalog.
If provided, idxs specifies the names of indexes to update.
"""

def uncatalog_object(uid):
"""Uncatalogs the object with the unique identifier 'uid'.
The uid must be a physical path!
The uid must be a physical path, either absolute or relative to
the catalog.
"""

def uniqueValuesFor(name):
Expand Down

0 comments on commit 3b3b1ef

Please sign in to comment.