org.ametys.plugins.repository.metadata

Interface ModifiableFolder

All Superinterfaces:

Folder

All Known Implementing Classes:

JCRFolder

public interface ModifiableFolder
extends Folder

Folder that is not read only

Method Summary

Modifier and Type	Method and Description
ModifiableFile	addFile(String fileName) Add a file with the specified name in this folder.
ModifiableFolder	addFolder(String folderName) Add a folder with the specified name in this folder.
ModifiableFile	getFile(String fileName) Returns the file with the specified name.
Collection<ModifiableFile>	getFiles() Returns a Collection containing all files of this folder.
ModifiableFolder	getFolder(String folderName) Returns the folder with the specified name.
Collection<ModifiableFolder>	getFolders() Returns a Collection containing all subfolders of this folder.
void	remove(String name) Removes the sub-element represented by the specified name.
void	removeAll() Removes all files and folders in this folder.

Methods inherited from interface org.ametys.plugins.repository.metadata.Folder

getName, hasFile

Method Detail

getFolders

Collection<ModifiableFolder> getFolders()
                                 throws AmetysRepositoryException

Description copied from interface: Folder

Returns a Collection containing all subfolders of this folder.

Specified by:

getFolders in interface Folder

Returns:

a Collection containing all subfolders of this folder.

Throws:

AmetysRepositoryException - if an error occurs

getFolder

ModifiableFolder getFolder(String folderName)
                    throws UnknownMetadataException,
                           AmetysRepositoryException

Description copied from interface: Folder

Returns the folder with the specified name.

Specified by:

getFolder in interface Folder

Parameters:

folderName - the name of the folder.

Returns:

the folder with the specified name.

Throws:

UnknownMetadataException - if the folder does not exist.

AmetysRepositoryException - if an error occurs.

getFiles

Collection<ModifiableFile> getFiles()
                             throws AmetysRepositoryException

Description copied from interface: Folder

Returns a Collection containing all files of this folder.

Specified by:

getFiles in interface Folder

Returns:

a Collection containing all files of this folder.

Throws:

AmetysRepositoryException - if an error occurs.

getFile

ModifiableFile getFile(String fileName)
                throws UnknownMetadataException,
                       AmetysRepositoryException

Description copied from interface: Folder

Returns the file with the specified name.

Specified by:

getFile in interface Folder

Parameters:

fileName - the name of the file.

Returns:

the file with the specified name.

Throws:

UnknownMetadataException - if the folder does not exist.

AmetysRepositoryException - if an error occurs.

addFolder

ModifiableFolder addFolder(String folderName)
                    throws RepositoryIntegrityViolationException,
                           AmetysRepositoryException

Add a folder with the specified name in this folder.

Parameters:

folderName - the folder name.

Returns:

the created folder.

Throws:

RepositoryIntegrityViolationException - if a file or a folder already exists with the given name.

AmetysRepositoryException - if an error occurs.

addFile

ModifiableFile addFile(String fileName)
                throws RepositoryIntegrityViolationException,
                       AmetysRepositoryException

Add a file with the specified name in this folder.

Parameters:

fileName - the file name.

Returns:

the created file.

Throws:

RepositoryIntegrityViolationException - if a file or a folder already exists with the given name.

AmetysRepositoryException - if an error occurs.

remove

void remove(String name)
     throws UnknownMetadataException,
            AmetysRepositoryException

Removes the sub-element represented by the specified name.

Parameters:

name - the name of the folder or file to be removed.

Throws:

UnknownMetadataException - if no folder nor file does exists.

AmetysRepositoryException - if an error occurs.

removeAll

void removeAll()
        throws AmetysRepositoryException

Removes all files and folders in this folder.

Throws:

AmetysRepositoryException - if an error occurs.