webdav.Lockable.LockableItem

Package webdav :: Module Lockable :: Class LockableItem

[show private | hide private]

Class LockableItem

EtagSupport --+
              |
             LockableItem

Known Subclasses:: Resource

Implements the WriteLockInterface, and is inherited by Resource which is then inherited by the majority of Zope objects. For an object to be lockable, however, it should have the WriteLockInterface in its __implements__ list, ie:

__implements__ = (WriteLockInterface,)

Method Summary
	`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`, `http__parseMatchList`, `http__processMatchHeaders`, `http__refreshEtag`

Class Variable Summary
`tuple`	`__ac_permissions__` = `(('Manage WebDAV Locks', ('wl_clear...`
`Implements`	`__implemented__` = `<implementedBy webdav.Lockable.Lockabl...`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`
`PermissionRole`	`wl_clearLocks__roles__` = `<PermissionRole object at 0xfa5...`
`PermissionRole`	`wl_delLock__roles__` = `<PermissionRole object at 0xfaa0>`
`NoneType`	`wl_getLock__roles__` = None
`NoneType`	`wl_isLocked__roles__` = None
`NoneType`	`wl_isLockedByUser__roles__` = None
`NoneType`	`wl_lockItems__roles__` = None
`tuple`	`wl_lockmapping__roles__` = `()`
`NoneType`	`wl_lockTokens__roles__` = None
`NoneType`	`wl_lockValues__roles__` = None
`PermissionRole`	`wl_setLock__roles__` = `<PermissionRole object at 0xfb90>`
Inherited from `EtagSupport`: `__implements__`, `__providedBy__`

Method Details

wl_lockmapping(self, killinvalids=0, create=0)

if 'killinvalids' is 1, locks who are no longer valid will be deleted

Class Variable Details

__ac_permissions__

Type:: tuple
Value:: (('Manage WebDAV Locks', ('wl_clearLocks',)), ('WebDAV Lock items', ('wl_setLock',), ('Owner', 'Manager')), ('WebDAV Unlock items', ('wl_delLock',), ('Owner', 'Manager')))

implemented

Type:: Implements
Value:: <implementedBy webdav.Lockable.LockableItem>

provides

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

wl_clearLocksroles

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

wl_delLockroles

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

wl_getLockroles

Type:: NoneType
Value:: None

wl_isLockedroles

Type:: NoneType
Value:: None

wl_isLockedByUserroles

Type:: NoneType
Value:: None

wl_lockItemsroles

Type:: NoneType
Value:: None

wl_lockmappingroles

Type:: tuple
Value:: ()

wl_lockTokensroles

Type:: NoneType
Value:: None

wl_lockValuesroles

Type:: NoneType
Value:: None

wl_setLockroles

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

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

http://epydoc.sf.net

Class LockableItem

wl_lockmapping(self, killinvalids=0, create=0)

__ac_permissions__

__implemented__

__provides__

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__