Products.ZCatalog.CatalogAwareness.CatalogAware

Package Products :: Package ZCatalog :: Module CatalogAwareness :: Class CatalogAware

[show private | hide private]

Class CatalogAware

Known Subclasses:: ClassifierEntry

This is a Mix-In class to make objects automaticly catalog and uncatalog themselves in Zope, and to provide some other basic attributes that are useful to catalog. Note that if your class or ZClass subclasses CatalogAware, it will only catalog itself when it is added or copied in Zope. If you make changes to your own object, you are responsible for calling your object's index_object method.

Method Summary
	`creator(self)` Return a sequence of user names who have the local Owner role on an object.
	`index_object(self)` A common method to allow Findables to index themselves.
	`manage_afterAdd(self, item, container)`
	`manage_afterClone(self, item)`
	`manage_beforeDelete(self, item, container)`
	`manage_editCataloger(self, default, REQUEST)`
	`onDeleteObject(self)` Object delete handler.
	`reindex_all(self, obj)`
	`reindex_object(self)` Suprisingly useful
	`summary(self, num)` Return a summary of the text content of the object.
	`unindex_object(self)` A common method to allow Findables to unindex themselves.
	`url(self, ftype, fhost)` Return a SCRIPT_NAME-based url for an object.

Class Variable Summary
`str`	`default_catalog` = `'Catalog'`
`DTMLFile`	`manage_editCatalogerForm` = `<App.special_dtml.DTMLFile ob...`
`str`	`meta_type` = `'CatalogAware'`

Method Details

creator(self)

Return a sequence of user names who have the local Owner role on an object. The name creator is used for this method to conform to Dublin Core.

index_object(self)

A common method to allow Findables to index themselves.

onDeleteObject(self)

Object delete handler. I think this is obsoleted by manage_beforeDelete

reindex_object(self)

Suprisingly useful

summary(self, num=200)

Return a summary of the text content of the object.

unindex_object(self)

A common method to allow Findables to unindex themselves.

url(self, ftype=<function splittype at 0x102e1f0>, fhost=<function splithost at 0x102e230>)

Return a SCRIPT_NAME-based url for an object.

Class Variable Details

default_catalog

Type:: str
Value:: 'Catalog'

manage_editCatalogerForm

Type:: DTMLFile
Value:: <App.special_dtml.DTMLFile object at 0x159c350>

meta_type

Type:: str
Value:: 'CatalogAware'

Generated by Epydoc 2.1 on Thu Aug 16 09:55:13 2007

http://epydoc.sf.net