Trees       Index       Help   
Package CMFCore :: Module PortalObject :: Class PortalObjectBase
[show private | hide private]
[frames | no frames]

Type PortalObjectBase

                       OrderSupport --+    
                                      |    
                 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 --+    
                                      |    
                           PortalFolder --+
                                          |
             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 --+   |
                                      |   |
                 SkinnableObjectManager --+
                                          |
                                         PortalObjectBase

Implements portal content management, but not UI details.
Method Summary
  __getattr__(self, name)
Looks for the name in an object with wrappers that only reach up to the root skins folder.
  __of__(self, parent)
Sneakily sets up the portal skin then returns the wrapper that Acquisition.Implicit.__of__() would return.
  getSkinsFolderName(self)
  _checkId(self, id, allow_dup)
Override of ObjectManager._checkId().
    Inherited from PortalFolder
  manage_addPortalFolder(self, id, title, REQUEST)
Add a new PortalFolder object with id *id*.
    Inherited from OrderSupport
  getDefaultSorting(self)
Get default sorting key and direction.
  getObjectPosition(self, id)
Get the position of an object by its id.
  manage_move_objects_down(self, REQUEST, ids, delta)
Move specified sub-objects down by delta in container.
  manage_move_objects_to_bottom(self, REQUEST, ids)
Move specified sub-objects to bottom of container.
  manage_move_objects_to_top(self, REQUEST, ids)
Move specified sub-objects to top of container.
  manage_move_objects_up(self, REQUEST, ids, delta)
Move specified sub-objects up by delta in container.
  manage_renameObject(self, id, new_id, REQUEST)
Rename a particular sub-object without changing its position.
  manage_set_default_sorting(self, REQUEST, key, reverse)
Set default sorting key and direction.
  moveObjectsByDelta(self, ids, delta, subset_ids)
Move specified sub-objects by delta.
  moveObjectsDown(self, ids, delta, subset_ids)
Move specified sub-objects down by delta in container.
  moveObjectsToBottom(self, ids, subset_ids)
Move specified sub-objects to bottom of container.
  moveObjectsToTop(self, ids, subset_ids)
Move specified sub-objects to top of container.
  moveObjectsUp(self, ids, delta, subset_ids)
Move specified sub-objects up by delta in container.
  moveObjectToPosition(self, id, position)
Move specified object to absolute position.
  orderObjects(self, key, reverse)
Order sub-objects by key and direction.
  setDefaultSorting(self, key, reverse)
Set default sorting key and direction.
  tpValues(self)
    Inherited from PortalFolderBase
  __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.
  _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__(self, arg1, arg2)
Pre-traversal hook.
  _getPortalTypeName(self)
Get the portal type name that can be passed to portal_types.
  getActionInfo(self, action_chain, check_visibility, check_condition)
Get an Action info mapping specified by a chain of actions.
  getIcon(self, relative_to_portal)
Using this method allows the content class creator to grab icons on the fly instead of using a fixed attribute on the class.
  getPortalTypeName(self)
Get the portal type name that can be passed to portal_types.
  getTypeInfo(self)
Get the TypeInformation object specified by the portal type.
  _setPortalTypeName(self, pt)
Set the portal type name.
    Inherited from CMFCatalogAware
  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).
    Inherited from Folder
  externalEditLink_(self, object, borrow_lock)
Insert the external editor link to an object if appropriate
  icon(self, relative_to_portal)
Using this method allows the content class creator to grab icons on the fly instead of using a fixed attribute on the class.
  manage_addZGadflyConnection(self, id, title, connection, check, REQUEST)
  manage_addZGadflyConnectionForm(self, REQUEST, *args, **kw)
  SQLConnectionIDs(self)
Find SQL database connections in the current folder and above
  ZQueryIds(self)
    Inherited from ObjectManager
  __class_init__(self)
  __getitem__(self, key)
  addDTMLDocument(self, id, title, file, REQUEST, submit)
Add a DTML Document object with the contents of file.
  addDTMLMethod(self, id, title, file, REQUEST, submit)
Add a DTML Method object with the contents of file.
  all_meta_types(self, interfaces)
  filtered_meta_types(self, user)
  list_imports(self)
  manage_addDocument(self, id, title, file, REQUEST, submit)
Add a DTML Method object with the contents of file.
  manage_addDTMLDocument(self, id, title, file, REQUEST, submit)
Add a DTML Document object with the contents of file.
  manage_addDTMLMethod(self, id, title, file, REQUEST, submit)
Add a DTML Method object with the contents of file.
  manage_addFile(self, id, file, title, precondition, content_type, REQUEST)
Add a new File object.
  manage_addImage(self, id, file, title, precondition, content_type, REQUEST)
Add a new Image object.
  manage_addOrderedFolder(self, id, title, createPublic, createUserF, REQUEST)
Add a new ordered Folder object with id *id*.
  manage_addSiteRoot(self, title, base, path, REQUEST, **ignored)
  manage_addUserFolder(self, dtself, REQUEST, **ignored)
  manage_delObjects(self, ids, REQUEST)
Delete a subordinate object
  manage_exportObject(self, id, download, toxml, RESPONSE, REQUEST)
Exports an object to a file and returns that file.
  manage_FTPlist(self, REQUEST)
Directory listing for FTP.
  manage_FTPstat(self, REQUEST)
Psuedo stat, used by FTP for directory listings.
  manage_hasId(self, REQUEST)
check if the folder has an object with REQUEST['id']
  manage_importObject(self, file, REQUEST, set_owner)
Import an object from a file
  objectIds(self, spec)
  objectIds_d(self, t)
  objectItems(self, spec)
  objectItems_d(self, t)
  objectMap(self)
  objectMap_d(self, t)
  objectValues(self, spec)
  objectValues_d(self, t)
  superValues(self, t)
  _delOb(self, id)
  _delObject(self, id, dp)
  _getOb(self, id, default)
  _importObjectFromFile(self, filepath, verify, set_owner)
  _setOb(self, id, object)
  _setObject(self, id, object, roles, user, set_owner)
  _subobject_permissions(self)
    Inherited from CopyContainer
  _old_manage_renameObject(self, id, new_id, REQUEST)
Rename a particular sub-object
  cb_dataItems(self)
  cb_dataValid(self)
  manage_clone(self, ob, id, REQUEST)
  manage_CopyContainerAllItems(self, REQUEST)
  manage_CopyContainerFirstItem(self, REQUEST)
  manage_copyObjects(self, ids, REQUEST, RESPONSE)
Put a reference to the objects named in ids in the clip board
  manage_cutObjects(self, ids, REQUEST)
Put a reference to the objects named in ids in the clip board
  manage_pasteObjects(self, cb_copy_data, REQUEST)
Paste previously copied objects into the current object.
  manage_renameObjects(self, ids, new_ids, REQUEST)
Rename several sub-objects
  validClipData(self)
  _get_id(self, id)
    Inherited from Navigation
  manage_zmi_logout(self, REQUEST, RESPONSE)
Logout current user
    Inherited from Tabs
  _old_filtered_manage_options(self, REQUEST)
  class_manage_path(self)
  filtered_manage_options(self, REQUEST)
  manage_workspace(self, REQUEST)
Dispatch to first interface in manage_options
  tabs_path_default(self, REQUEST, unquote)
  tabs_path_info(self, script, path, quote)
    Inherited from Acquirer
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
    Inherited from Persistent
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  bobobase_modification_time(self)
  locked_in_version(self)
Was the object modified in any version?
  modified_in_version(self)
Was the object modified in this version?
    Inherited from Persistent
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getstate__(...)
Get the object serialization state
  __reduce__(...)
Reduce an object to contituent parts for serialization
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __setstate__(...)
Set the object serialization state The state should be in one of 3 forms: - None Ignored - A dictionary In this case, the object's instance dictionary will be cleared and updated with the new state.
  _p_activate()
_p_activate() -- Activate the object
  _p_deactivate()
_p_deactivate() -- Deactivate the object
  _p_delattr(name)
This method should be called by subclass __delattr__ implementations before doing anything else.
  _p_getattr(name)
The method unghostifies the object, if necessary.
  _p_invalidate()
_p_invalidate() -- Invalidate the object
  _p_setattr(name, value)
This method should be called by subclass __setattr__ implementations before doing anything else.
    Inherited from Collection
  dav__init(self, request, response)
  DELETE(self, REQUEST, RESPONSE)
Delete a collection resource.
  HEAD(self, REQUEST, RESPONSE)
Retrieve resource information without a response body.
  PUT(self, REQUEST, RESPONSE)
The PUT method has no inherent meaning for collection resources, though collections are not specifically forbidden to handle PUT requests.
    Inherited from Resource
  COPY(self, REQUEST, RESPONSE)
Create a duplicate of the source resource whose state and behavior match that of the source resource as closely as possible.
  dav__simpleifhandler(self, request, response, method, col, url, refresh)
  dav__validate(self, object, methodname, REQUEST)
  LOCK(self, REQUEST, RESPONSE)
Lock a resource
  manage_DAVget(self)
Gets the document source
  MKCOL(self, REQUEST, RESPONSE)
Create a new collection resource.
  MOVE(self, REQUEST, RESPONSE)
Move a resource to a new location.
  OPTIONS(self, REQUEST, RESPONSE)
Retrieve communication options.
  PROPFIND(self, REQUEST, RESPONSE)
Retrieve properties defined on the resource.
  PROPPATCH(self, REQUEST, RESPONSE)
Set and/or remove properties defined on the resource.
  TRACE(self, REQUEST, RESPONSE)
Return the HTTP message received back to the client as the entity-body of a 200 (OK) response.
  UNLOCK(self, REQUEST, RESPONSE)
Remove an existing lock on a resource.
    Inherited from LockableItem
  wl_clearLocks(self)
  wl_delLock(self, locktoken)
  wl_getLock(self, locktoken)
  wl_hasLock(self, token, killinvalids)
  wl_isLocked(self)
  wl_lockItems(self, killinvalids)
  wl_lockmapping(self, killinvalids, create)
if 'killinvalids' is 1, locks who are no longer valid will be deleted
  wl_lockTokens(self, killinvalids)
  wl_lockValues(self, killinvalids)
  wl_setLock(self, locktoken, lock)
    Inherited from EtagSupport
  http__etag(self, readonly)
  http__parseMatchList(self, REQUEST, header)
  http__processMatchHeaders(self, REQUEST)
  http__refreshEtag(self)
    Inherited from Traversable
  absolute_url(self, relative)
Return the absolute URL of the object.
  absolute_url_path(self)
Return the path portion of the absolute URL of the object.
  getPhysicalPath(self)
Get the physical path of the object.
  restrictedTraverse(self, path, default)
  unrestrictedTraverse(self, path, default, restricted)
Lookup an object by path.
  virtual_url_path(self)
Return a URL for the object, relative to the site root.
    Inherited from PropertyManager
  getProperty(self, id, d)
Get the property 'id'.
  getPropertyType(self, id)
Get the type of property 'id'.
  hasProperty(self, id)
Return true if object has a property 'id'.
  manage_addProperty(self, id, value, type, REQUEST)
Add a new property via the web.
  manage_changeProperties(self, REQUEST, **kw)
Change existing object properties.
  manage_changePropertyTypes(self, old_ids, props, REQUEST)
Replace one set of properties with another
  manage_delProperties(self, ids, REQUEST)
Delete one or more properties specified by 'ids'.
  manage_editProperties(self, REQUEST)
Edit object properties via the web.
  propdict(self)
  propertyIds(self)
Return a list of property ids.
  propertyItems(self)
Return a list of (id,property) tuples.
  propertyLabel(self, id)
Return a label for the given property id
  propertyMap(self)
Return a tuple of mappings, giving meta-data for properties.
  propertyValues(self)
Return a list of actual property objects.
  valid_property_id(self, id)
  _delProperty(self, id)
  _delPropValue(self, id)
  _propertyMap(self)
Return a tuple of mappings, giving meta-data for properties.
  _setProperty(self, id, value, type)
  _setPropValue(self, id, value)
  _updateProperty(self, id, value)
  _wrapperCheck(self, object)
    Inherited from ElementWithAttributes
  getAttribute(self, name)
Retrieves an attribute value by name.
  getAttributeNode(self, name)
Retrieves an Attr node by name or None if there is no such attribute.
  getAttributes(self)
Returns a NamedNodeMap containing the attributes of this node (if it is an element) or None otherwise.
    Inherited from Element
  getChildNodes(self)
Returns a NodeList that contains all children of this node.
  getElementsByTagName(self, tagname)
Returns a NodeList of all the Elements with a given tag name in the order in which they would be encountered in a preorder traversal of the Document tree.
  getFirstChild(self)
The first child of this node.
  getLastChild(self)
The last child of this node.
  getNextSibling(self)
The node immediately preceding this node.
  getNodeName(self)
The name of this node, depending on its type
  getNodeType(self)
A code representing the type of the node.
  getParentNode(self)
The parent of this node.
  getPreviousSibling(self)
The node immediately preceding this node.
  getTagName(self)
The name of the element
    Inherited from Node
  getNodeValue(self)
The value of this node, depending on its type
  getOwnerDocument(self)
The Document object associated with this node.
  hasChildNodes(self)
Returns true if the node has any children, false if it doesn't.
    Inherited from RoleManager
  ac_inherited_permissions(self, all)
  access_debug_info(self)
Return debug info.
  acquiredRolesAreUsedBy(self, permission)
Used by management screen.
  get_local_roles(self)
  get_local_roles_for_userid(self, userid)
  get_valid_userids(self)
  has_local_roles(self)
  manage_access(self, REQUEST, **kw)
Return an interface for making permissions settings.
  manage_acquiredPermissions(self, permissions, REQUEST)
Change the permissions that acquire.
  manage_addLocalRoles(self, userid, roles, REQUEST)
Set local roles for a user.
  manage_changePermissions(self, REQUEST)
Change all permissions settings, called by management screen.
  manage_defined_roles(self, submit, REQUEST)
Called by management screen.
  manage_delLocalRoles(self, userids, REQUEST)
Remove all local roles for a user.
  manage_editRoles(self, REQUEST, acl_type, acl_roles)
  manage_permission(self, permission_to_manage, roles, acquire, REQUEST)
Change the settings for the given permission.
  manage_role(self, role_to_manage, permissions, REQUEST)
Change the permissions given to the given role.
  manage_setLocalRoles(self, userid, roles, REQUEST)
Set local roles for a user.
  permission_settings(self, permission)
Return user-role permission settings.
  permissionsOfRole(self, role)
Used by management screen.
  possible_permissions(self)
  rolesOfPermission(self, permission)
Used by management screen.
  userdefined_roles(self)
Return list of user-defined roles.
  users_with_local_role(self, role)
  valid_roles(self)
Return list of valid roles.
  validate_roles(self, roles)
Return true if all given roles are valid.
  validRoles(self)
Return list of valid roles.
  _addRole(self, role, REQUEST)
  _delRoles(self, roles, REQUEST)
  _has_user_defined_role(self, role)
  _setRoles(self, acl_type, acl_roles)
    Inherited from RoleManager
  manage_getPermissionMapping(self)
Return the permission mapping for the object This is a list of dictionaries with: permission_name -- The name of the native object permission class_permission -- The class permission the permission is mapped to.
  manage_setPermissionMapping(self, permission_names, class_permissions, REQUEST)
Change the permission mapping
  _isBeingAccessedAsZClassDefinedInstanceMethod(self)
  _isBeingUsedAsAMethod(self, REQUEST, wannaBe)
    Inherited from Item
  __len__(self)
  __repr__(self)
Show the physical path of the object and its context if available.
  analyseDocumentation(self, object, type, filter)
  getId(self)
Return the id of the object as a string.
  manage_editedDialog(self, REQUEST, **args)
  raise_standardErrorMessage(self, client, REQUEST, error_type, error_value, tb, error_tb, error_message, tagSearch, error_log_url)
  this(self)
  title_and_id(self)
Return the title if it is not blank and the id otherwise.