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

Type PortalFolderBase

                 object --+        
                          |        
                       Base --+    
                              |    
                CMFCatalogAware --+
                                  |
                    DynamicType --+
                                  |
         object --+               |
                  |               |
               Base --+           |
                      |           |
    EtagSupport --+   |           |
                  |   |           |
       LockableItem --+           |
                      |           |
               Resource --+       |
                          |       |
                 Collection --+   |
                              |   |
             object --+       |   |
                      |       |   |
                   Base --+   |   |
                          |   |   |
                FindSupport --+   |
                              |   |
             object --+       |   |
                      |       |   |
                   Base --+   |   |
                          |   |   |
         object --+       |   |   |
                  |       |   |   |
               Base --+   |   |   |
                      |   |   |   |
             CopySource --+   |   |
                          |   |   |
               Node --+   |   |   |
                      |   |   |   |
                Element --+   |   |
                          |   |   |
         object --+       |   |   |
                  |       |   |   |
               Base --+   |   |   |
                      |   |   |   |
                  Owned --+   |   |
                          |   |   |
         object --+       |   |   |
                  |       |   |   |
               Base --+   |   |   |
                      |   |   |   |
    EtagSupport --+   |   |   |   |
                  |   |   |   |   |
       LockableItem --+   |   |   |
                      |   |   |   |
               Resource --+   |   |
                          |   |   |
         object --+       |   |   |
                  |       |   |   |
               Base --+   |   |   |
                      |   |   |   |
                   Tabs --+   |   |
                          |   |   |
            Traversable --+   |   |
                          |   |   |
         object --+       |   |   |
                  |       |   |   |
               Base --+   |   |   |
                      |   |   |   |
            UndoSupport --+   |   |
                          |   |   |
                       Item --+   |
                              |   |
     object --+               |   |
              |               |   |
           Base --+           |   |
                  |           |   |
EtagSupport --+   |           |   |
              |   |           |   |
   LockableItem --+           |   |
                  |           |   |
           Resource --+       |   |
                      |       |   |
             Collection --+   |   |
                          |   |   |
         object --+       |   |   |
                  |       |   |   |
               Base --+   |   |   |
                      |   |   |   |
          CopyContainer --+   |   |
                          |   |   |
         object --+       |   |   |
                  |       |   |   |
               Base --+   |   |   |
                      |   |   |   |
             Navigation --+   |   |
                          |   |   |
         object --+       |   |   |
                  |       |   |   |
               Base --+   |   |   |
                      |   |   |   |
         object --+   |   |   |   |
                  |   |   |   |   |
         Persistent --+   |   |   |
                      |   |   |   |
             Persistent --+   |   |
                          |   |   |
         object --+       |   |   |
                  |       |   |   |
               Base --+   |   |   |
                      |   |   |   |
                   Tabs --+   |   |
                          |   |   |
            Traversable --+   |   |
                          |   |   |
         object --+       |   |   |
                  |       |   |   |
               Base --+   |   |   |
                      |   |   |   |
               Acquirer --+   |   |
                          |   |   |
              ObjectManager --+   |
                              |   |
             object --+       |   |
                      |       |   |
                   Base --+   |   |
                          |   |   |
           Node --+       |   |   |
                  |       |   |   |
            Element --+   |   |   |
                      |   |   |   |
  ElementWithAttributes --+   |   |
                          |   |   |
            PropertyManager --+   |
                              |   |
             object --+       |   |
                      |       |   |
                   Base --+   |   |
                          |   |   |
            RoleManager --+   |   |
                          |   |   |
                RoleManager --+   |
                              |   |
                         Folder --+
                                  |
                                 PortalFolderBase

Known Subclasses:
PortalFolder

Base class for portal folder
Method Summary
  __init__(self, id, title)
  allowedContentTypes(self)
List type info objects for types which can be added in this folder.
  checkIdAvailable(self, id)
  content_type(self)
WebDAV needs this to do the Right Thing (TM).
  contentIds(self, spec, filter)
  contentItems(self, spec, filter)
  contentValues(self, spec, filter)
  decodeFolderFilter(self, encoded)
Parse cookie string for using variables in dtml.
  Description(self)
Dublin Core Description element - resource summary.
  edit(self, title, description)
Edit the folder title (and possibly other attributes later)
  encodeFolderFilter(self, REQUEST)
Parse cookie string for using variables in dtml.
  indexObject(self)
Index the object in the portal catalog.
  invokeFactory(self, type_name, id, RESPONSE, *args, **kw)
Invokes the portal_types tool.
  listDAVObjects(self)
  listFolderContents(self, spec, contentFilter)
List viewable contentish and folderish sub-objects.
  manage_addFolder(self, id, title, REQUEST)
Add a new folder-like object with id *id*.
  MKCOL_handler(self, id, REQUEST, RESPONSE)
Handle WebDAV MKCOL.
  PUT_factory(self, name, typ, body)
Factory for PUT requests to objects which do not yet exist.
  reindexObject(self, idxs)
Reindex the object in the portal catalog.
  reindexObjectSecurity(self)
  setDescription(self, description)
Set Dublin Core Description element - resource summary.
  setTitle(self, title)
Set Dublin Core Title element - resource name.
  Title(self)
Dublin Core Title element - resource name.
  Type(self)
Dublin Core Type element - resource type.
  unindexObject(self)
Unindex the object from the portal catalog.
  _checkId(self, id, allow_dup)
  _filteredItems(self, ids, filt)
Apply filter, a mapping, to child objects indicated by 'ids', returning a sequence of ( id, obj ) tuples.
  _morphSpec(self, spec)
spec is a sequence of meta_types, a string containing one meta type, or None.
  _verifyObjectPaste(self, object, validate_src)
Inherited from DynamicType: __before_publishing_traverse__, _getPortalTypeName, getActionInfo, getIcon, getPortalTypeName, getTypeInfo, icon, _setPortalTypeName
Inherited from CMFCatalogAware: manage_afterAdd, manage_afterClone, manage_beforeDelete, manage_workflowsTab, notifyWorkflowCreated, opaqueIds, opaqueItems, opaqueValues, _getCatalogTool, _getWorkflowTool
Inherited from ObjectManager: __class_init__, __getitem__, all_meta_types, filtered_meta_types, hasObject, list_imports, manage_delObjects, manage_exportObject, manage_FTPlist, manage_FTPstat, manage_hasId, manage_importObject, objectIds, objectIds_d, objectItems, objectItems_d, objectMap, objectMap_d, objectValues, objectValues_d, superValues, tpValues, _delOb, _delObject, _getOb, _importObjectFromFile, _setOb, _setObject, _subobject_permissions
Inherited from CopyContainer: cb_dataItems, cb_dataValid, manage_clone, manage_CopyContainerAllItems, manage_CopyContainerFirstItem, manage_copyObjects, manage_cutObjects, manage_pasteObjects, manage_renameObject, manage_renameObjects, validClipData, _get_id
Inherited from Navigation: manage_zmi_logout
Inherited from Tabs: class_manage_path, filtered_manage_options, manage_workspace, tabs_path_default, tabs_path_info
Inherited from Acquirer: __new__, __of__
Inherited from Persistent: __getattribute__, bobobase_modification_time, locked_in_version, modified_in_version
Inherited from Persistent: __delattr__, __getstate__, __reduce__, __setattr__, __setstate__, _p_activate, _p_deactivate, _p_delattr, _p_getattr, _p_invalidate, _p_setattr
Inherited from Collection: dav__init, DELETE, HEAD, PUT
Inherited from Resource: COPY, dav__simpleifhandler, dav__validate, LOCK, manage_DAVget, MKCOL, MOVE, OPTIONS, PROPFIND, PROPPATCH, TRACE, UNLOCK
Inherited from LockableItem: wl_clearLocks, wl_delLock, wl_getLock, wl_hasLock, wl_isLocked, wl_lockItems, wl_lockmapping, wl_lockTokens, wl_lockValues, wl_setLock
Inherited from EtagSupport: http__etag, http__parseMatchList, http__processMatchHeaders, http__refreshEtag
Inherited from Traversable: absolute_url, absolute_url_path, getPhysicalPath, restrictedTraverse, unrestrictedTraverse, virtual_url_path
Inherited from PropertyManager: getProperty, getPropertyType, hasProperty, manage_addProperty, manage_changeProperties, manage_changePropertyTypes, manage_delProperties, manage_editProperties, propdict, propertyIds, propertyItems, propertyLabel, propertyMap, propertyValues, valid_property_id, _delProperty, _delPropValue, _propertyMap, _setProperty, _setPropValue, _updateProperty, _wrapperCheck
Inherited from ElementWithAttributes: getAttribute, getAttributeNode, getAttributes
Inherited from Element: getChildNodes, getElementsByTagName, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodeType, getParentNode, getPreviousSibling, getTagName
Inherited from Node: getNodeValue, getOwnerDocument, hasChildNodes
Inherited from RoleManager: ac_inherited_permissions, access_debug_info, acquiredRolesAreUsedBy, get_local_roles, get_local_roles_for_userid, get_valid_userids, has_local_roles, manage_access, manage_defined_roles, manage_editRoles, manage_role, permission_settings, permissionsOfRole, possible_permissions, rolesOfPermission, userdefined_roles, users_with_local_role, valid_roles, validate_roles, validRoles, _addRole, _delRoles, _has_user_defined_role, _setRoles, manage_acquiredPermissions, manage_addLocalRoles, manage_changePermissions, manage_delLocalRoles, manage_permission, manage_setLocalRoles
Inherited from RoleManager: manage_getPermissionMapping, _isBeingAccessedAsZClassDefinedInstanceMethod, _isBeingUsedAsAMethod, manage_setPermissionMapping
Inherited from Item: __len__, __repr__, getId, manage_editedDialog, raise_standardErrorMessage, this, title_and_id, title_or_id, tpURL
Inherited from CopySource: cb_isCopyable, cb_isMoveable, cb_userHasCopyOrMovePermission, _canCopy, _getCopy, _notifyOfCopyTo, _postCopy, _setId
Inherited from Owned: changeOwnership, getOwner, getOwnerTuple, getWrappedOwner, manage_fixupOwnershipAfterAdd, owner_info, userCanTakeOwnership, _deleteOwnershipAfterAdd, manage_changeOwnershipType, manage_takeOwnership
Inherited from UndoSupport: get_request_var_or_attr, manage_undo_transactions, undoable_transactions
Inherited from FindSupport: PrincipiaFind, ZopeFind, ZopeFindAndApply
Inherited from Base: __getnewargs__
Inherited from object: __hash__, __reduce_ex__, __str__

Class Variable Summary
tuple __ac_permissions__ = (('Add portal content', ('invokeFac...
tuple __implements__ = (<Interface Products.CMFCore.interfaces...
NoneType allowedContentTypes__roles__ = None                                                                  
PermissionRole checkIdAvailable__roles__ = <PermissionRole object at 0x...
NoneType contentIds__roles__ = None                                                                  
NoneType contentItems__roles__ = None                                                                  
NoneType contentValues__roles__ = None                                                                  
NoneType decodeFolderFilter__roles__ = None                                                                  
str description = ''
PermissionRole Description__roles__ = <PermissionRole object at 0x151c9...
PermissionRole edit__roles__ = <PermissionRole object at 0x151c770>
NoneType encodeFolderFilter__roles__ = None                                                                  
PermissionRole invokeFactory__roles__ = <PermissionRole object at 0x151...
PermissionRole listFolderContents__roles__ = <PermissionRole object at ...
PermissionRole manage_addFolder__roles__ = <PermissionRole object at 0x...
tuple manage_options = ({'action': 'manage_main', 'help': ('OF...
str meta_type = 'Portal Folder Base'
tuple meta_types = ()
PermissionRole setDescription__roles__ = <PermissionRole object at 0x15...
PermissionRole setTitle__roles__ = <PermissionRole object at 0x151c770>
PermissionRole Title__roles__ = <PermissionRole object at 0x151c9f8>
PermissionRole Type__roles__ = <PermissionRole object at 0x151c9f8>
Inherited from DynamicType: getActionInfo__roles__, getIcon__roles__, getPortalTypeName__roles__, getTypeInfo__roles__, icon__roles__, portal_type
Inherited from CMFCatalogAware: indexObject__roles__, manage_afterAdd__roles__, manage_afterClone__roles__, manage_beforeDelete__roles__, manage_workflowsTab__roles__, notifyWorkflowCreated__roles__, opaqueIds__roles__, opaqueItems__roles__, opaqueValues__roles__, reindexObject__roles__, reindexObjectSecurity__roles__, unindexObject__roles__, _cmf_security_indexes, _manage_workflowsTab
Inherited from Folder: __implemented__, __provides__, _properties
Inherited from ObjectManager: __roles__, isAnObjectManager, isPrincipiaFolderish, manage_addProduct, manage_delObjects__roles__, manage_exportObject__roles__, manage_FTPlist__roles__, manage_FTPstat__roles__, manage_hasId__roles__, manage_importExportForm, manage_importExportForm__roles__, manage_importObject__roles__, manage_index_main, manage_index_main__roles__, manage_main, manage_main__roles__, objectIds__roles__, objectItems__roles__, objectValues__roles__, _objects
Inherited from CopyContainer: __providedBy__, manage_clone__roles__, manage_CopyContainerAllItems__roles__, manage_CopyContainerFirstItem__roles__, manage_copyObjects__roles__, manage_cutObjects__roles__, manage_pasteObjects__roles__, manage_renameForm, manage_renameForm__roles__, manage_renameObject__roles__, manage_renameObjects__roles__
Inherited from Navigation: manage, manage__roles__, manage_copyright, manage_copyright__roles__, manage_form_title, manage_form_title__roles__, manage_menu, manage_menu__roles__, manage_page_footer, manage_page_footer__roles__, manage_page_header, manage_page_header__roles__, manage_page_style.css, manage_page_style.css__roles__, manage_top_frame, manage_top_frame__roles__, manage_zmi_logout__roles__, manage_zmi_prefs, manage_zmi_prefs__roles__, zope_quick_start, zope_quick_start__roles__
Inherited from Tabs: class_manage_path__roles__, filtered_manage_options__roles__, manage_tabs, manage_tabs__roles__, manage_workspace__roles__
Inherited from Persistent: _p_changed, _p_jar, _p_mtime, _p_oid, _p_serial, _p_state
Inherited from Collection: __dav_collection__
Inherited from Resource: __dav_resource__, __http_methods__, COPY__roles__, DELETE__roles__, HEAD__roles__, listDAVObjects__roles__, LOCK__roles__, manage_DAVget__roles__, MOVE__roles__, OPTIONS__roles__, PROPFIND__roles__, PROPPATCH__roles__, TRACE__roles__, UNLOCK__roles__
Inherited from LockableItem: wl_clearLocks__roles__, wl_delLock__roles__, wl_getLock__roles__, wl_isLocked__roles__, wl_isLockedByUser__roles__, wl_lockItems__roles__, wl_lockmapping__roles__, wl_lockTokens__roles__, wl_lockValues__roles__, wl_setLock__roles__
Inherited from Traversable: absolute_url__roles__, absolute_url_path__roles__, getPhysicalPath__roles__, getPhysicalRoot, getPhysicalRoot__roles__, restrictedTraverse__roles__, unrestrictedTraverse__roles__, virtual_url_path__roles__
Inherited from PropertyManager: __propsets__, getProperty__roles__, getPropertyType__roles__, hasProperty__roles__, manage_addProperty__roles__, manage_changeProperties__roles__, manage_changePropertyTypes__roles__, manage_delProperties__roles__, manage_editProperties__roles__, manage_propertiesForm, manage_propertiesForm__roles__, manage_propertyTypeForm, manage_propertyTypeForm__roles__, propdict__roles__, propertyIds__roles__, propertyItems__roles__, propertyLabel__roles__, propertyMap__roles__, propertysheets, propertyValues__roles__, title, valid_property_id__roles__, _reserved_names
Inherited from RoleManager: __ac_local_roles__, __ac_roles__, ac_inherited_permissions__roles__, access_debug_info__roles__, aclAChecked, aclEChecked, aclPChecked, acquiredRolesAreUsedBy__roles__, manage_access__roles__, manage_acquiredForm, manage_acquiredForm__roles__, manage_acquiredPermissions__roles__, manage_addLocalRoles__roles__, manage_changePermissions__roles__, manage_defined_roles__roles__, manage_delLocalRoles__roles__, manage_editLocalRoles, manage_editLocalRoles__roles__, manage_editRoles__roles__, manage_listLocalRoles, manage_listLocalRoles__roles__, manage_permission__roles__, manage_permissionForm, manage_permissionForm__roles__, manage_role__roles__, manage_roleForm, manage_roleForm__roles__, manage_setLocalRoles__roles__, permission_settings__roles__, permissionMappingPossibleValues, permissionsOfRole__roles__, rolesOfPermission__roles__, selectedRoles, smallRolesWidget, userdefined_roles__roles__, _method_manage_access, _normal_manage_access
Inherited from RoleManager: manage_getPermissionMapping__roles__, manage_setPermissionMapping__roles__
Inherited from Item: __allow_access_to_unprotected_subobjects__, __name__, getId__roles__, icon, id, isTopLevelPrincipiaApplicationObject, manage_editedDialog__roles__, REQUEST, _manage_editedDialog
Inherited from Owned: changeOwnership__roles__, getOwner__roles__, getOwnerTuple__roles__, getWrappedOwner__roles__, manage_changeOwnershipType__roles__, manage_fixupOwnershipAfterAdd__roles__, manage_owner, manage_owner__roles__, manage_takeOwnership__roles__, owner_info__roles__
Inherited from UndoSupport: manage_undo_transactions__roles__, manage_UndoForm, manage_UndoForm__roles__, undoable_transactions__roles__
Inherited from FindSupport: manage_findAdv, manage_findAdv__roles__, manage_findForm, manage_findForm__roles__, manage_findFrame, manage_findFrame__roles__, manage_findResult, manage_findResult__roles__, PrincipiaFind__roles__, ZopeFind__roles__, ZopeFindAndApply__roles__

Method Details

allowedContentTypes(self)

List type info objects for types which can be added in this folder.

content_type(self)

WebDAV needs this to do the Right Thing (TM).

decodeFolderFilter(self, encoded)

Parse cookie string for using variables in dtml.

Description(self)

Dublin Core Description element - resource summary.

edit(self, title='', description='')

Edit the folder title (and possibly other attributes later)

encodeFolderFilter(self, REQUEST)

Parse cookie string for using variables in dtml.

indexObject(self)

Index the object in the portal catalog.
Overrides:
Products.CMFCore.CMFCatalogAware.CMFCatalogAware.indexObject (inherited documentation)

invokeFactory(self, type_name, id, RESPONSE=None, *args, **kw)

Invokes the portal_types tool.

listFolderContents(self, spec=None, contentFilter=None)

List viewable contentish and folderish sub-objects.

manage_addFolder(self, id, title='', REQUEST=None)

Add a new folder-like object with id *id*.

IF present, use the parent object's 'mkdir' alias; otherwise, just add a PortalFolder.

MKCOL_handler(self, id, REQUEST=None, RESPONSE=None)

Handle WebDAV MKCOL.

PUT_factory(self, name, typ, body)

Factory for PUT requests to objects which do not yet exist.

Used by NullResource.PUT.

Returns -- Bare and empty object of the appropriate type (or None, if we don't know what to do)

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.
Overrides:
Products.CMFCore.CMFCatalogAware.CMFCatalogAware.reindexObject (inherited documentation)

setDescription(self, description)

Set Dublin Core Description element - resource summary.

setTitle(self, title)

Set Dublin Core Title element - resource name.

Title(self)

Dublin Core Title element - resource name.

Type(self)

Dublin Core Type element - resource type.

unindexObject(self)

Unindex the object from the portal catalog.
Overrides:
Products.CMFCore.CMFCatalogAware.CMFCatalogAware.unindexObject (inherited documentation)

_filteredItems(self, ids, filt)

Apply filter, a mapping, to child objects indicated by 'ids', returning a sequence of ( id, obj ) tuples.

_morphSpec(self, spec)

spec is a sequence of meta_types, a string containing one meta type, or None. If spec is empty or None, returns all contentish meta_types. Otherwise ensures all of the given meta types are contentish.

Class Variable Details

__ac_permissions__

Type:
tuple
Value:
(('Add portal content',
  ('invokeFactory', 'checkIdAvailable'),
  ('Owner', 'Manager')),
 ('Add portal folders', ('manage_addFolder',)),
 ('List folder contents', ('listFolderContents',)),
 ('Manage properties', ('setDescription', 'edit', 'setTitle')),
 ('View', ('Description', 'Title', 'Type')))                           

__implements__

Type:
tuple
Value:
(<Interface Products.CMFCore.interfaces.Folderish.Folderish at 16511f0\
>,
 <Interface Products.CMFCore.interfaces.Dynamic.DynamicType at 14ce7b0\
>,
 (<Interface webdav.WriteLockInterface.WriteLockInterface at 13c9bb0>,\
))                                                                     

allowedContentTypes__roles__

Type:
NoneType
Value:
None                                                                  

checkIdAvailable__roles__

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

contentIds__roles__

Type:
NoneType
Value:
None                                                                  

contentItems__roles__

Type:
NoneType
Value:
None                                                                  

contentValues__roles__

Type:
NoneType
Value:
None                                                                  

decodeFolderFilter__roles__

Type:
NoneType
Value:
None                                                                  

description

Type:
str
Value:
''                                                                     

Description__roles__

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

edit__roles__

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

encodeFolderFilter__roles__

Type:
NoneType
Value:
None                                                                  

invokeFactory__roles__

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

listFolderContents__roles__

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

manage_addFolder__roles__

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

manage_options

Type:
tuple
Value:
({'action': 'manage_main',
  'help': ('OFSP', 'ObjectManager_Contents.stx'),
  'label': 'Contents'},
 {'action': '', 'help': ('OFSP', 'Folder_View.stx'), 'label': 'View'},
 {'action': 'manage_propertiesForm',
  'help': ('OFSP', 'Properties.stx'),
  'label': 'Properties'},
 {'action': 'manage_access',
...                                                                    

meta_type

Type:
str
Value:
'Portal Folder Base'                                                   

meta_types

Type:
tuple
Value:
()                                                                     

setDescription__roles__

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

setTitle__roles__

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

Title__roles__

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

Type__roles__

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

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