org.apache.wvcm.store
Interface FolderAccessor

All Superinterfaces:
Accessor, ResourceAccessor
All Known Implementing Classes:
FolderWebdavAccessor

public interface FolderAccessor
extends ResourceAccessor

Persistent folder state accessor.

Version:
$Revision: 1.1.1.1.2.3 $

Method Summary
 void doBind(java.lang.String bindingName, Resource boundResource, boolean overwrite)
          Add a binding.
 java.util.List doLocateByHistoryReport(java.util.List versionHistoryList, PropertyNameList wantedPropertyList)
          Return a list of ControllableResource objects that identify the controllable resources that are members of this ControllableFolder and whose versionHistory property identifies a member of the versionHistoryList parameter.
 java.util.Iterator doReadMemberList(PropertyNameList wantedPropertyList, boolean deep)
          Return a list of proxies containing the requested set of properties, where the list contains the folder itself and other members of that folder.
 void doRebind(java.lang.String bindingName, Resource boundResource, boolean overwrite)
          Remove a binding and add a binding.
 void doUnbind(java.lang.String bindingName)
          Remove a binding.
 
Methods inherited from interface org.apache.wvcm.store.ResourceAccessor
doCheckExists, doCopy, doDelete, doLock, doMove, doReadAccessControlList, doReadContent, doReadProperties, doSearch, doUnlock, doWriteAccessControlList, doWriteContent, doWriteProperties, resource
 
Methods inherited from interface org.apache.wvcm.store.Accessor
serverWorkspaceFolderList
 

Method Detail

doReadMemberList

java.util.Iterator doReadMemberList(PropertyNameList wantedPropertyList,
                                    boolean deep)
                                    throws WvcmException
Return a list of proxies containing the requested set of properties, where the list contains the folder itself and other members of that folder.

Parameters:
wantedPropertyList - the requested set of properties
deep - if true, the result contains a proxy for every member of the folder associated to this accessor; otherwise, the result contains only proxies for the bound members of the folder.
Returns:
an Iterator
Throws:
WvcmException

doBind

void doBind(java.lang.String bindingName,
            Resource boundResource,
            boolean overwrite)
            throws WvcmException
Add a binding.

Parameters:
bindingName - a String
boundResource - a Resource
overwrite - a boolean
Throws:
WvcmException

doRebind

void doRebind(java.lang.String bindingName,
              Resource boundResource,
              boolean overwrite)
              throws WvcmException
Remove a binding and add a binding.

Parameters:
bindingName - a String
boundResource - a Resource
overwrite - a boolean
Throws:
WvcmException

doUnbind

void doUnbind(java.lang.String bindingName)
              throws WvcmException
Remove a binding.

Parameters:
bindingName - a String
Throws:
WvcmException

doLocateByHistoryReport

java.util.List doLocateByHistoryReport(java.util.List versionHistoryList,
                                       PropertyNameList wantedPropertyList)
                                       throws WvcmException
Return a list of ControllableResource objects that identify the controllable resources that are members of this ControllableFolder and whose versionHistory property identifies a member of the versionHistoryList parameter.

Parameters:
versionHistoryList - A list of VersionHistory objects that are being located.
wantedPropertyList - The properties to be retrieved for the returned version-controlled resources.
Throws:
WvcmException


Copyright (c) 2003 - Apache Software Foundation