com.haulmont.cuba.core.app

Interface FoldersService

All Known Implementing Classes:

FoldersServiceBean

public interface FoldersService

Folders pane support service.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
byte[]	exportFolder(Folder folder) Export folder as zip archive.
Folder	importFolder(Folder parentFolder, byte[] bytes) Import folder
java.util.List<AppFolder>	loadAppFolders() Load application folders available to a user.
java.util.List<SearchFolder>	loadSearchFolders() Load search folders for the current user.
java.util.List<AppFolder>	reloadAppFolders(java.util.List<AppFolder> folders) Reload quantity and style information for supplied application folders.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

loadAppFolders

java.util.List<AppFolder> loadAppFolders()

Load application folders available to a user.

Returns:

folders list

reloadAppFolders

java.util.List<AppFolder> reloadAppFolders(java.util.List<AppFolder> folders)

Reload quantity and style information for supplied application folders.

Parameters:

folders - folders to reload

Returns:

reloaded folders list

loadSearchFolders

java.util.List<SearchFolder> loadSearchFolders()

Load search folders for the current user.

Returns:

folders list

exportFolder

byte[] exportFolder(Folder folder)
             throws java.io.IOException

Export folder as zip archive.

Parameters:

folder - exported folder

Returns:

zip contents

Throws:

java.io.IOException

importFolder

Folder importFolder(Folder parentFolder,
                    byte[] bytes)
             throws java.io.IOException

Import folder

Parameters:

parentFolder -

bytes -

Returns:

Throws:

java.io.IOException