Package webdav :: Module Collection :: Class Collection
[show private | hide private]
[frames | no frames]

Type Collection

     object --+        
              |        
           Base --+    
                  |    
EtagSupport --+   |    
              |   |    
   LockableItem --+    
                  |    
           Resource --+
                      |
                     Collection

Known Subclasses:
Folder, ObjectManager

The Collection class provides basic WebDAV support for collection objects. It provides default implementations for all supported WebDAV HTTP methods. The behaviors of some WebDAV HTTP methods for collections are slightly different than those for non-collection resources.
Method Summary
  dav__init(self, request, response)
  DELETE(self, REQUEST, RESPONSE)
Delete a collection resource.
  HEAD(self, REQUEST, RESPONSE)
Retrieve resource information without a response body.
  listDAVObjects(self)
  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, 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 Base: __getattribute__, __getnewargs__, __getstate__, __new__, __reduce__, __setstate__
Inherited from object: __init__, __delattr__, __hash__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variable Summary
int __dav_collection__ = 1                                                                     
Implements __implemented__ = <implementedBy webdav.Collection.Colle...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
Inherited from Resource: __ac_permissions__, __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 EtagSupport: __implements__, __providedBy__

Method Details

DELETE(self, REQUEST, RESPONSE)

Delete a collection resource. For collection resources, DELETE may return either 200 (OK) or 204 (No Content) to indicate total success, or may return 207 (Multistatus) to indicate partial success. Note that in Zope a DELETE currently never returns 207.
Overrides:
webdav.Resource.Resource.DELETE

HEAD(self, REQUEST, RESPONSE)

Retrieve resource information without a response body.
Overrides:
webdav.Resource.Resource.HEAD

PUT(self, REQUEST, RESPONSE)

The PUT method has no inherent meaning for collection resources, though collections are not specifically forbidden to handle PUT requests. The default response to a PUT request for collections is 405 (Method Not Allowed).
Overrides:
webdav.Resource.Resource.PUT

Class Variable Details

__dav_collection__

Type:
int
Value:
1                                                                     

__implemented__

Type:
Implements
Value:
<implementedBy webdav.Collection.Collection>                           

__provides__

Type:
ClassProvides
Value:
<zope.interface.declarations.ClassProvides object at 0x15ad210>        

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