Trees       Index       Help   

Zenoss

Package Products :: Package CMFCore :: Module CMFCatalogAware :: Class CMFCatalogAware
[show private | hide private]
[frames | no frames]

Type CMFCatalogAware

object --+    
         |    
      Base --+
             |
            CMFCatalogAware

Known Subclasses:
PortalFolderBase
Mix-in for notifying portal_catalog and portal_workflow
Method Summary
  indexObject(self)
Index the object in the portal catalog.
  manage_afterAdd(self, item, container)
Add self to the catalog.
  manage_afterClone(self, item)
Add self to the workflow.
  manage_beforeDelete(self, item, container)
Remove self from the catalog.
  manage_workflowsTab(self, REQUEST, manage_tabs_message)
Tab displaying the current workflows for the content object.
  notifyWorkflowCreated(self)
Notify the workflow that self was just created.
  opaqueIds(self)
Return opaque ids (subelements that are contained using something that is not an ObjectManager).
  opaqueItems(self)
Return opaque items (subelements that are contained using something that is not an ObjectManager).
  opaqueValues(self)
Return opaque values (subelements that are contained using something that is not an ObjectManager).
  reindexObject(self, idxs)
Reindex the object in the portal catalog.
  reindexObjectSecurity(self, skip_self)
Reindex security-related indexes on the object.
  unindexObject(self)
Unindex the object from the portal catalog.
Inherited from Base: __getattribute__, __getnewargs__, __getstate__, __new__, __reduce__, __setstate__
Inherited from object: __init__, __delattr__, __hash__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variable Summary
tuple __ac_permissions__ = (('Access contents information', ('...
PermissionRole indexObject__roles__ = <PermissionRole object at 0x151ca...
tuple manage_afterAdd__roles__ = ('Manager',)
tuple manage_afterClone__roles__ = ('Manager',)
tuple manage_beforeDelete__roles__ = ('Manager',)
tuple manage_options = ({'action': 'manage_workflowsTab', 'lab...
PermissionRole manage_workflowsTab__roles__ = <PermissionRole object at...
tuple notifyWorkflowCreated__roles__ = ()
PermissionRole opaqueIds__roles__ = <PermissionRole object at 0x151c950...
PermissionRole opaqueItems__roles__ = <PermissionRole object at 0x151c9...
PermissionRole opaqueValues__roles__ = <PermissionRole object at 0x151c...
PermissionRole reindexObject__roles__ = <PermissionRole object at 0x151...
PermissionRole reindexObjectSecurity__roles__ = <PermissionRole object ...
PermissionRole unindexObject__roles__ = <PermissionRole object at 0x151...

Method Details

indexObject(self)

Index the object in the portal catalog.

manage_afterAdd(self, item, container)

Add self to the catalog. (Called when the object is created or moved.)

manage_afterClone(self, item)

Add self to the workflow. (Called when the object is cloned.)

manage_beforeDelete(self, item, container)

Remove self from the catalog. (Called when the object is deleted or moved.)

manage_workflowsTab(self, REQUEST, manage_tabs_message=None)

Tab displaying the current workflows for the content object.

notifyWorkflowCreated(self)

Notify the workflow that self was just created.

opaqueIds(self)

Return opaque ids (subelements that are contained using something that is not an ObjectManager).

opaqueItems(self)

Return opaque items (subelements that are contained using something that is not an ObjectManager).

opaqueValues(self)

Return opaque values (subelements that are contained using something that is not an ObjectManager).

reindexObject(self, idxs=[])

Reindex the object in the portal catalog. If idxs is present, only those indexes are reindexed. The metadata is always updated.

Also update the modification date of the object, unless specific indexes were requested.

reindexObjectSecurity(self, skip_self=False)

Reindex security-related indexes on the object.

Recurses in the children to reindex them too.

If skip_self is True, only the children will be reindexed. This is a useful optimization if the object itself has just been fully reindexed, as there's no need to reindex its security twice.

unindexObject(self)

Unindex the object from the portal catalog.

Class Variable Details

__ac_permissions__

Type:
tuple
Value:
(('Access contents information', ('opaqueItems', 'opaqueIds', 'opaqueV\
alues')),
 ('Manage portal', ('manage_workflowsTab',)),
 ('Modify portal content',
  ('reindexObjectSecurity', 'indexObject', 'reindexObject', 'unindexOb\
ject')))

indexObject__roles__

Type:
PermissionRole
Value:
<PermissionRole object at 0x151ca88>

manage_afterAdd__roles__

Type:
tuple
Value:
('Manager',)

manage_afterClone__roles__

Type:
tuple
Value:
('Manager',)

manage_beforeDelete__roles__

Type:
tuple
Value:
('Manager',)

manage_options

Type:
tuple
Value:
({'action': 'manage_workflowsTab', 'label': 'Workflows'},)

manage_workflowsTab__roles__

Type:
PermissionRole
Value:
<PermissionRole object at 0x151c698>

notifyWorkflowCreated__roles__

Type:
tuple
Value:
()

opaqueIds__roles__

Type:
PermissionRole
Value:
<PermissionRole object at 0x151c950>

opaqueItems__roles__

Type:
PermissionRole
Value:
<PermissionRole object at 0x151c950>

opaqueValues__roles__

Type:
PermissionRole
Value:
<PermissionRole object at 0x151c950>

reindexObject__roles__

Type:
PermissionRole
Value:
<PermissionRole object at 0x151ca88>

reindexObjectSecurity__roles__

Type:
PermissionRole
Value:
<PermissionRole object at 0x151ca88>

unindexObject__roles__

Type:
PermissionRole
Value:
<PermissionRole object at 0x151ca88>

   Trees       Index       Help   

Zenoss

Generated by Epydoc 2.1 on Thu Aug 16 09:55:16 2007 http://epydoc.sf.net