org.gcube.common.homelibrary.home.workspace

Interface WorkspaceFolder

All Superinterfaces:

WorkspaceItem

All Known Subinterfaces:

WorkspaceSharedFolder, WorkspaceTrashFolder, WorkspaceTrashItem, WorkspaceVREFolder

public interface WorkspaceFolder
extends WorkspaceItem

Author:

Federico De Faveri defaveri@isti.cnr.it

Method Summary

Methods

Modifier and Type	Method and Description
ExternalFile	createExternalFileItem(String name, String description, String mimeType, File fileData) Create an External File into this folder.
ExternalFile	createExternalFileItem(String name, String description, String mimeType, InputStream fileData) Create an External File into this folder.
FolderItem	createExternalFileItem(String name, String description, String mimeType, String storageId) Create an External File into this folder.
FolderItem	createExternalGenericItem(String name, String description, InputStream is) Create a generic item
FolderItem	createExternalGenericItem(String name, String description, InputStream is, Map<String,String> properties) Create a generic item with properties by inpustream
FolderItem	createExternalGenericItem(String name, String description, String storageId) Create a generic item by storage id
FolderItem	createExternalGenericItem(String name, String description, String storageId, Map<String,String> properties) Create a generic item with properties by storage id
ExternalImage	createExternalImageItem(String name, String description, String mimeType, File imageData) Create a new External Image into this folder.
ExternalImage	createExternalImageItem(String name, String description, String mimeType, InputStream imageData) Create a new External Image into this folder.
ExternalPDFFile	createExternalPDFFileItem(String name, String description, String mimeType, File tmpFile) Create a new External PDF file into this folder.
ExternalPDFFile	createExternalPDFFileItem(String name, String description, String mimeType, InputStream fileData) Create a new External PDF file into this folder.
ExternalUrl	createExternalUrlItem(String name, String description, File tmpFile) Create an External URL into this folder.
ExternalUrl	createExternalUrlItem(String name, String description, InputStream url) Create an External URL into this folder.
ExternalUrl	createExternalUrlItem(String name, String description, String url) Create an External URL into this folder.
WorkspaceFolder	createFolder(String name, String description) Create a new folder into this folder.
Query	createQueryItem(String name, String description, InputStream query, QueryType queryType) Create a new Query into this folder.
Query	createQueryItem(String name, String description, String query, QueryType queryType) Create a new Query into this folder.
Report	createReportItem(String name, String description, Calendar created, Calendar lastEdit, String author, String lastEditBy, String templateName, int numberOfSections, String status, InputStream reportData) Create a Report into this folder.
ReportTemplate	createReportTemplateItem(String name, String description, Calendar created, Calendar lastEdit, String author, String lastEditBy, int numberOfSections, String status, InputStream templateData) Create a Report Template into this folder.
TimeSeries	createTimeSeries(String name, String description, String timeseriesId, String title, String creator, String timeseriesDescription, String timeseriesCreationDate, String publisher, String sourceId, String sourceName, String rights, long dimension, List<String> headerLabels, InputStream compressedCSV) Create a new Time Series.
boolean	exists(String name) Check if an item with the specified name exists.
WorkspaceItem	find(String name) Get an item with the specified name.
List<WorkspaceItem>	getChildren() Get children of the current folder
int	getCount() Get the number of items in a folder
List<WorkspaceItem>	getHiddenChildren() Get hidden children of the current folder
List<WorkspaceItem>	getLastItems(int limit) Get items ordered by jcr:lastModified
FolderBulkCreator	getNewFolderBulkCreator() Create a new FolderBulkCreator for this folder.
long	getSize() Get the size of a folder
String	getUniqueName(String initialName, boolean b) Get an unique name for an item
void	setACL(List<String> users, ACLType privilege) Set a privilege to a list of users
WorkspaceSharedFolder	share(List<String> users)

Methods inherited from interface org.gcube.common.homelibrary.home.workspace.WorkspaceItem

cloneItem, deleteACL, getAccounting, getACLOwner, getACLUser, getCapabilities, getCreationTime, getDescription, getId, getIdSharedFolder, getLastAction, getLastModificationTime, getLastUpdatedBy, getName, getOwner, getParent, getPath, getProperties, getPublicLink, getReaders, getReferences, getRemotePath, getStorageID, getType, hasAccessRight, isFolder, isHidden, isMarkedAsRead, isRoot, isShared, isTrashed, markAsRead, move, remove, removeChild, rename, setDescription, setHidden

Method Detail

getChildren

List<WorkspaceItem> getChildren()
                                throws InternalErrorException

Get children of the current folder

Specified by:

getChildren in interface WorkspaceItem

Returns:

a list of children

Throws:

InternalErrorException - if an error occurs.

getHiddenChildren

List<WorkspaceItem> getHiddenChildren()
                                      throws InternalErrorException

Get hidden children of the current folder

Returns:

a list of hidden children

Throws:

InternalErrorException

exists

boolean exists(String name)
               throws InternalErrorException

Check if an item with the specified name exists.

Parameters:

name - the name to check.

Returns:

true if the item exists, false otherwise.

Throws:

InternalErrorException - if an error occurs.

find

WorkspaceItem find(String name)
                   throws InternalErrorException

Get an item with the specified name.

Parameters:

name - the item name to find.

Returns:

the item if is found, null otherwise.

Throws:

InternalErrorException - if an error occurs.

createFolder

WorkspaceFolder createFolder(String name,
                           String description)
                             throws InternalErrorException,
                                    InsufficientPrivilegesException,
                                    ItemAlreadyExistException

Create a new folder into this folder.

Parameters:

name - the folder name.

description - the folder description.

Returns:

the new folder.

Throws:

InternalErrorException - if an internal error occurs.

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

ItemAlreadyExistException - if an item with the specified name already exists in this folder.

createExternalImageItem

ExternalImage createExternalImageItem(String name,
                                    String description,
                                    String mimeType,
                                    InputStream imageData)
                                      throws InsufficientPrivilegesException,
                                             InternalErrorException,
                                             ItemAlreadyExistException

Create a new External Image into this folder.

Parameters:

name - the external image name.

description - the external image description.

mimeType - the external image mime type.

imageData - the external image data.

Returns:

the new external image.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

createExternalImageItem

ExternalImage createExternalImageItem(String name,
                                    String description,
                                    String mimeType,
                                    File imageData)
                                      throws InsufficientPrivilegesException,
                                             InternalErrorException,
                                             ItemAlreadyExistException

Create a new External Image into this folder.

Parameters:

name - the external image name.

description - the external image description.

mimeType - the external image mime type.

imageData - the external image data.

Returns:

the new external image.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

createExternalFileItem

ExternalFile createExternalFileItem(String name,
                                  String description,
                                  String mimeType,
                                  File fileData)
                                    throws InsufficientPrivilegesException,
                                           InternalErrorException,
                                           ItemAlreadyExistException

Create an External File into this folder.

Parameters:

name - the external file name.

description - the external file description.

mimeType - the external file mime type.

fileData - the external file data.

Returns:

the new external file.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

createExternalPDFFileItem

ExternalPDFFile createExternalPDFFileItem(String name,
                                        String description,
                                        String mimeType,
                                        File tmpFile)
                                          throws InsufficientPrivilegesException,
                                                 InternalErrorException,
                                                 ItemAlreadyExistException

Create a new External PDF file into this folder.

Parameters:

name - the external PDF name.

description - the external PDF description.

mimeType - the external PDF mime type.

tmpFile - the PDF tmpFile

Returns:

the new external PDF.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

createExternalUrlItem

ExternalUrl createExternalUrlItem(String name,
                                String description,
                                File tmpFile)
                                  throws InsufficientPrivilegesException,
                                         InternalErrorException,
                                         ItemAlreadyExistException

Create an External URL into this folder.

Parameters:

name - the external URL name.

description - the external URL description.

url - the URL.

Returns:

the new URL file.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

IOException

createExternalFileItem

FolderItem createExternalFileItem(String name,
                                String description,
                                String mimeType,
                                String storageId)
                                  throws InsufficientPrivilegesException,
                                         InternalErrorException,
                                         ItemAlreadyExistException

Create an External File into this folder.

Parameters:

name - the external file name.

description - the external file description.

mimeType - the external file mime type.

storageId - the storage ID used to save temporarily the file

Returns:

the new external file.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

createExternalFileItem

ExternalFile createExternalFileItem(String name,
                                  String description,
                                  String mimeType,
                                  InputStream fileData)
                                    throws InsufficientPrivilegesException,
                                           InternalErrorException,
                                           ItemAlreadyExistException

Create an External File into this folder.

Parameters:

name - the external file name.

description - the external file description.

mimeType - the external file mime type.

fileData - the external file data.

Returns:

the new external file.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

createExternalPDFFileItem

ExternalPDFFile createExternalPDFFileItem(String name,
                                        String description,
                                        String mimeType,
                                        InputStream fileData)
                                          throws InsufficientPrivilegesException,
                                                 InternalErrorException,
                                                 ItemAlreadyExistException

Create a new External PDF file into this folder.

Parameters:

name - the external PDF name.

description - the external PDF description.

mimeType - the external PDF mime type.

fileData - the external PDF data.

Returns:

the new external PDF.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

createExternalUrlItem

ExternalUrl createExternalUrlItem(String name,
                                String description,
                                String url)
                                  throws InsufficientPrivilegesException,
                                         InternalErrorException,
                                         ItemAlreadyExistException

Create an External URL into this folder.

Parameters:

name - the external URL name.

description - the external URL description.

url - the URL.

Returns:

the new URL file.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

IOException

createExternalUrlItem

ExternalUrl createExternalUrlItem(String name,
                                String description,
                                InputStream url)
                                  throws InsufficientPrivilegesException,
                                         InternalErrorException,
                                         ItemAlreadyExistException

Create an External URL into this folder.

Parameters:

name - the external URL name.

description - the external URL description.

url - the URL.

Returns:

the new URL file.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

IOException

createReportTemplateItem

ReportTemplate createReportTemplateItem(String name,
                                      String description,
                                      Calendar created,
                                      Calendar lastEdit,
                                      String author,
                                      String lastEditBy,
                                      int numberOfSections,
                                      String status,
                                      InputStream templateData)
                                        throws InsufficientPrivilegesException,
                                               InternalErrorException,
                                               ItemAlreadyExistException

Create a Report Template into this folder.

Parameters:

name - the template name.

description - the template description.

created - the template creation time.

lastEdit - the last edit time.

author - the template author.

lastEditBy - the last template editor.

numberOfSections - the number of sections.

status - the template status.

templateData - the template data.

Returns:

the template.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

createReportItem

Report createReportItem(String name,
                      String description,
                      Calendar created,
                      Calendar lastEdit,
                      String author,
                      String lastEditBy,
                      String templateName,
                      int numberOfSections,
                      String status,
                      InputStream reportData)
                        throws InsufficientPrivilegesException,
                               InternalErrorException,
                               ItemAlreadyExistException

Create a Report into this folder.

Parameters:

name - the report name.

description - the report description.

created - the report creation time.

lastEdit - the last edit time.

author - the report author.

lastEditBy - the last report editor.

templateName - the source template name.

numberOfSections - the number of sections.

status - the report status.

reportData - the report data.

Returns:

the report.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

createQueryItem

Query createQueryItem(String name,
                    String description,
                    String query,
                    QueryType queryType)
                      throws InsufficientPrivilegesException,
                             InternalErrorException,
                             ItemAlreadyExistException

Create a new Query into this folder.

Parameters:

name - the query name.

description - the query description.

query - the query.

queryType - the query type.

Returns:

the new query.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

createQueryItem

Query createQueryItem(String name,
                    String description,
                    InputStream query,
                    QueryType queryType)
                      throws InsufficientPrivilegesException,
                             InternalErrorException,
                             ItemAlreadyExistException

Create a new Query into this folder.

Parameters:

name - the query name.

description - the query description.

query - the query.

queryType - the query type.

Returns:

the new query.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

createTimeSeries

TimeSeries createTimeSeries(String name,
                          String description,
                          String timeseriesId,
                          String title,
                          String creator,
                          String timeseriesDescription,
                          String timeseriesCreationDate,
                          String publisher,
                          String sourceId,
                          String sourceName,
                          String rights,
                          long dimension,
                          List<String> headerLabels,
                          InputStream compressedCSV)
                            throws InsufficientPrivilegesException,
                                   InternalErrorException,
                                   ItemAlreadyExistException

Create a new Time Series.

Parameters:

name - the item name.

description - the item description.

timeseriesId - the Time Series id.

title - the Time Series title.

creator - the Time Series creator.

timeseriesDescription - the Time Series description.

timeseriesCreationDate - the Time Series creation date.

publisher - the Time Series publisher.

sourceId - the Time Series source id.

sourceName - the Time Series source name.

rights - the Time Series rights.

dimension - the Time Series dimension.

headerLabels - the Time Series headers label.

compressedCSV - the Time Series csv compressed representation (with labels and UTF-8 encoded).

Returns:

the created Time Series.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if an item with the specified name already exists.

getNewFolderBulkCreator

FolderBulkCreator getNewFolderBulkCreator()
                                          throws InternalErrorException

Create a new FolderBulkCreator for this folder.

Returns:

the new FolderBulkCreator.

Throws:

InternalErrorException - if an internal error occurs.

share

WorkspaceSharedFolder share(List<String> users)
                            throws InsufficientPrivilegesException,
                                   WrongDestinationException,
                                   InternalErrorException

Parameters:

useers -

Returns:

Throws:

InsufficientPrivilegesException

WrongDestinationException

InternalErrorException

setACL

void setACL(List<String> users,
          ACLType privilege)
            throws InternalErrorException

Set a privilege to a list of users

Parameters:

users -

privilege -

Throws:

InternalErrorException

getUniqueName

String getUniqueName(String initialName,
                   boolean b)
                     throws InternalErrorException

Get an unique name for an item

Parameters:

initialName -

Returns:

Throws:

InternalErrorException

getSize

long getSize()
             throws InternalErrorException

Get the size of a folder

Returns:

folder size in bytes

Throws:

InternalErrorException

getCount

int getCount()
             throws InternalErrorException

Get the number of items in a folder

Returns:

the number of items in a folder

Throws:

InternalErrorException

getLastItems

List<WorkspaceItem> getLastItems(int limit)
                                 throws InternalErrorException

Get items ordered by jcr:lastModified

Parameters:

limit: - The maximum result size

Returns:

Throws:

InternalErrorException

createExternalGenericItem

FolderItem createExternalGenericItem(String name,
                                   String description,
                                   InputStream is)
                                     throws InternalErrorException,
                                            InsufficientPrivilegesException,
                                            ItemAlreadyExistException

Create a generic item

Parameters:

name -

description -

mimeType -

is -

Returns:

the created item

Throws:

InternalErrorException

ItemAlreadyExistException

InsufficientPrivilegesException

createExternalGenericItem

FolderItem createExternalGenericItem(String name,
                                   String description,
                                   InputStream is,
                                   Map<String,String> properties)
                                     throws InternalErrorException,
                                            InsufficientPrivilegesException,
                                            ItemAlreadyExistException

Create a generic item with properties by inpustream

Parameters:

name -

description -

is -

properties -

Returns:

the created item

Throws:

InternalErrorException

InsufficientPrivilegesException

ItemAlreadyExistException

createExternalGenericItem

FolderItem createExternalGenericItem(String name,
                                   String description,
                                   String storageId,
                                   Map<String,String> properties)
                                     throws InsufficientPrivilegesException,
                                            InternalErrorException,
                                            ItemAlreadyExistException

Create a generic item with properties by storage id

Parameters:

name -

description -

mimeType -

storageId -

properties -

Returns:

the created item

Throws:

InsufficientPrivilegesException

InternalErrorException

ItemAlreadyExistException

createExternalGenericItem

FolderItem createExternalGenericItem(String name,
                                   String description,
                                   String storageId)
                                     throws InsufficientPrivilegesException,
                                            InternalErrorException,
                                            ItemAlreadyExistException

Create a generic item by storage id

Parameters:

name -

description -

storageId -

Returns:

the created item

Throws:

InsufficientPrivilegesException

InternalErrorException

ItemAlreadyExistException