javax.wvcm
Interface Folder

All Superinterfaces:

Resource

All Known Subinterfaces:

ControllableFolder, FolderVersion, VersionHistory, Workspace

public interface Folder

extends Resource

A folder is a resource that contains a set of named mappings to other resources, called the "bound members" of that folder. The "members" of a folder are the folder itself and all members of the bound members of the folder. The semantics of a folder is similar to those of a Windows folder, a Unix directory, or a WebDAV collection.

Nested Class Summary

static interface

Folder.Binding A Binding in a Folder is a mapping from a name to a Resource that is a bound member of the Folder.

Method Summary

Iterator	doReadMemberList(PropertyNameList wantedPropertyList, boolean deep) Return an iterator of Resource objects that contain properties of the resources that are bound members of this Folder.
List	getBindingList() Return a list of Binding objects that identify the bound members of this Folder.

Methods inherited from interface Resource

doBind, doCopy, doReadContent, doReadProperties, doRebind, doUnbind, doWriteContent, doWriteProperties, getAttribute, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getDisplayName, getLastModified, getParentBindingList, getPropertyNameList, getProviderList, getResourceIdentifier, getUpdatedPropertyList, getWorkspaceFolderList, location, removeAttribute, setAttribute, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setDisplayName

Method Detail

doReadMemberList

public Iterator doReadMemberList(PropertyNameList wantedPropertyList,
                                 boolean deep)
                                    throws WvcmException

Return an iterator of Resource objects that contain properties of the resources that are bound members of this Folder. If deep is true, then all members of the folder (including this Folder) are included.

Parameters:

wantedPropertyList - The list of properties to be retrieved.

deep - Whether to retrieve properties for all members of this Folder.

Throws:

WvcmException - Postconditions:
(read-bound-members): The result contains a proxy for each bound member of the folder.
(read-all-members): If deep is true, the result contains a proxy for every member of the folder identified by this Folder.

getBindingList

public List getBindingList()
                              throws WvcmException

Return a list of Binding objects that identify the bound members of this Folder.

Throws:

WvcmException - if this Folder was not created with BINDING_LIST as a wanted property.