com.ibm.portal.resolver.webdav.tree
Interface WebdavLockableTreeModel<T>

All Superinterfaces:
Disposable, WebdavTreeModel<T>
All Known Subinterfaces:
WebdavLockableTreeModelController<T,M>

public interface WebdavLockableTreeModel<T>
extends WebdavTreeModel<T>

Implemented by tree models that can provide information about their locking state.

Since:
6.1.5
Note:
This interface is designed to be implemented by clients.

Nested Class Summary
static class WebdavLockableTreeModel.SupportedLockType
          Enumeration about the supported locks for a particular item
 
Method Summary
 WebdavLockableTreeModel.SupportedLockType getSupportedLock(T item)
           Returns information about the supported lock type.
 void visitLocks(WebdavLockHandler handler, T item)
           Queries the locks for a particular resource.
 
Methods inherited from interface com.ibm.portal.resolver.webdav.tree.WebdavTreeModel
createDataSource, getItem, getLocalized, getName, getTreeModel, isCollection
 
Methods inherited from interface com.ibm.portal.Disposable
dispose
 

Method Detail

getSupportedLock

WebdavLockableTreeModel.SupportedLockType getSupportedLock(T item)

Returns information about the supported lock type.

The information is used to compute the following WebDAV properties:

supportedlock
To provide a listing of the lock capabilities supported by the resource.

Parameters:
item - item, not null
Returns:
the supported lock type, not null

visitLocks

void visitLocks(WebdavLockHandler handler,
                T item)
                throws org.xml.sax.SAXException,
                       java.io.IOException

Queries the locks for a particular resource. The lock provider writes all locks to the given resource to the lock handler.

The information is used to compute the following WebDAV properties:

lockdiscovery
Describes the active locks on a resource.

Parameters:
handler - handler to write the locks on, not null
item - item, not null
Throws:
org.xml.sax.SAXException
java.io.IOException