org.olat.core.util.vfs
Interface VFSContainer

All Superinterfaces:

VFSItem

All Known Implementing Classes:

AbstractVirtualContainer, LocalFolderImpl, MergeSource, NamedContainerImpl, OlatNamedContainerImpl, OlatRootFolderImpl, VirtualContainer

public interface VFSContainer
extends VFSItem

Description:
TODO: Felix Jost Class Description for VFSContainer

Initial Date: 23.06.2005

Author:

Felix Jost

Method Summary

VFSStatus	copyFrom(VFSItem source) copy either a file or a folder to this folder.
VFSContainer	createChildContainer(java.lang.String name) Create a new child container (of same type) if possible.
VFSLeaf	createChildLeaf(java.lang.String name) Create a new leaf (of same type) if possible,
VFSItemFilter	getDefaultItemFilter()
java.util.List<VFSItem>	getItems()
java.util.List<VFSItem>	getItems(VFSItemFilter filter)
void	setDefaultItemFilter(VFSItemFilter defaultFilter) Set a default filter that will be applied to this container getItems method

Methods inherited from interface org.olat.core.util.vfs.VFSItem

canCopy, canDelete, canRename, canWrite, delete, getLastModified, getLocalSecurityCallback, getName, getParentContainer, isSame, rename, resolve, setLocalSecurityCallback, setParentContainer

Method Detail

getItems

java.util.List<VFSItem> getItems()

Returns:

a list of VFSItem containing

getItems

java.util.List<VFSItem> getItems(VFSItemFilter filter)

Returns:

a list of VFSItem which are accepted by the given filter. If a default filter is set, the default filter will be applied in addition to the given filter in this method

copyFrom

VFSStatus copyFrom(VFSItem source)

copy either a file or a folder to this folder. e.g. this folder is based at /bla/blu, copying source bli (from /whatever/bli) will add a child bli, so it looks like /bla/blu/bli later. the operation fails when the source or target do not support canCopyFrom and canCopyTo, resp., or there is already a child with the same name, or the quota would be exceeded.

Parameters:

source - the source (must exist)

Returns:

the status

createChildContainer

VFSContainer createChildContainer(java.lang.String name)

Create a new child container (of same type) if possible.

Parameters:

name -

Returns:

VFSItem if successfull, null otherwise.

createChildLeaf

VFSLeaf createChildLeaf(java.lang.String name)

Create a new leaf (of same type) if possible,

Parameters:

name -

Returns:

VFSItem if successfull, null otherwise.

setDefaultItemFilter

void setDefaultItemFilter(VFSItemFilter defaultFilter)

Set a default filter that will be applied to this container getItems method

Parameters:

defaultFilter -

getDefaultItemFilter

VFSItemFilter getDefaultItemFilter()

Returns:

The default filter for this container or NULL if no filter is set