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(self, readonly)`
	`http__parseMatchList(self, REQUEST, header)`
	`http__processMatchHeaders(self, REQUEST)`
	`http__refreshEtag(self)`

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 0xb75...`
`PermissionRole`	`wl_delLock__roles__` = `<PermissionRole object at 0xb7558d...`
`NoneType`	`wl_getLock__roles__` = None
`PermissionRole`	`wl_grantLockToUser__roles__` = `<PermissionRole object at ...`
`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 0xb7558e...`
Inherited from EtagSupport
`tuple`	`__implements__` = `(<Interface webdav.EtagSupport.EtagBase...`
`ClassProvides`	`__providedBy__` = `<zope.interface.declarations.ClassProvi...`

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', 'wl_grantLockToUser'), ('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 0xb72ed38c>

wl_clearLocksroles

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

wl_delLockroles

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

wl_getLockroles

Type:: NoneType
Value:: None

wl_grantLockToUserroles

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

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 0xb7558e00>

Generated by Epydoc 2.1 on Wed Nov 30 03:58:30 2005

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_grantLockToUser__roles__

wl_isLocked__roles__

wl_isLockedByUser__roles__

wl_lockItems__roles__

wl_lockmapping__roles__

wl_lockTokens__roles__

wl_lockValues__roles__

wl_setLock__roles__