Workspace (home-library 2.4.0-SNAPSHOT API)

All Superinterfaces:

WorkspaceEventSource
```
public interface Workspace
extends WorkspaceEventSource
```
Represents a user workspace.

Author:

Valentina Marioli valentina.marioli@isti.cnr.it

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBookmark(String itemId, String destinationFolderId)` Deprecated.
`List<SearchItem>`	`advancedSearch(String name, SearchItemByOperator date, SearchItemByOperator size)` Deprecated.
`void`	`changeDescription(String itemId, String newDescription)` Change an item description.
`WorkspaceItem`	`cloneItem(String itemId, String cloneName)` Clone an item in the same folder.
`WorkspaceItem`	`copy(String itemId, String destinationFolderId)` Copy an item from a folder to another folder.
`WorkspaceItem`	`copy(String itemId, String newName, String destinationFolderId)` Copy an item from a folder to another folder.
`WorkspaceInternalLink`	`copyAsLink(String itemId, String destinationFolderId)` Create a link of a given item in a destination folder
`ExternalFile`	`createExternalFile(String name, String description, String mimeType, InputStream fileData, String destinationFolderId)` Create a new External File into a folder.
`ExternalFile`	`createExternalFile(String name, String description, String mimeType, InputStream fileData, String destinationFolderId, Map<String,String> properties)` Create a new External File with properties
`ExternalImage`	`createExternalImage(String name, String description, String mimeType, InputStream imageData, String destinationFolderId)` Create a new External Image into a folder.
`ExternalImage`	`createExternalImage(String name, String description, String mimeType, InputStream imageData, String destinationFolderId, Map<String,String> properties)` Create a new External Image with properties
`ExternalPDFFile`	`createExternalPDFFile(String name, String description, String mimeType, InputStream fileData, String destinationFolderId)` Create a new External PDF File into a folder.
`ExternalPDFFile`	`createExternalPDFFile(String name, String description, String mimeType, InputStream fileData, String destinationFolderId, Map<String,String> properties)` Create a new External PDF File with properties
`ExternalUrl`	`createExternalUrl(String name, String description, InputStream url, String destinationfolderId)` Create a new External URL into a folder.
`ExternalUrl`	`createExternalUrl(String name, String description, String url, String destinationFolderId)` Create a new External URL into a folder.
`WorkspaceFolder`	`createFolder(String name, String description, String destinationFolderId)` Create a new folder with specified name.
`WorkspaceFolder`	`createFolder(String name, String description, String destinationFolderId, Map<String,String> properties)` Create a new folder with properties
`WorkspaceItem`	`createGcubeItem(String name, String description, List<String> scopes, String creator, String itemType, Map<String,String> properties, String destinationFolderId)` Create a GCubeItem
`Query`	`createQuery(String name, String description, InputStream query, QueryType queryType, String destinationfolderId)` Create a new query into a folder.
`Query`	`createQuery(String name, String description, String query, QueryType queryType, String destinationfolderId)` Create a new query into a folder.
`Report`	`createReport(String name, String description, Calendar created, Calendar lastEdit, String author, String lastEditBy, String templateName, int numberOfSections, String status, InputStream reportData, String destinationfolderId)` Create a new Report into a folder.
`ReportTemplate`	`createReportTemplate(String name, String description, Calendar created, Calendar lastEdit, String author, String lastEditBy, int numberOfSections, String status, InputStream templateData, String destinationfolderId)` Create a new Report Template into a folder.
`WorkspaceSharedFolder`	`createSharedFolder(String name, String description, List<String> users, String destinationFolderId)` Create a shared folder with a list of users
`WorkspaceSharedFolder`	`createSharedFolder(String name, String description, String groupId, String destinationFolderId, String displayName, boolean isVREFolder)` Create a shared folder associated with a groupId
`WorkspaceSmartFolder`	`createSmartFolder(String name, String description, String query, String folderId)` Create a smart 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, String destinationfolderId)` Create a new Time Series.
`WorkspaceVREFolder`	`createVREFolder(String scope, String description, String displayName)` Create a VRE folder
`WorkflowReport`	`createWorkflowReport(String name, String description, String workflowId, String workflowStatus, String workflowData, String destinationfolderId)` Creates a Workflow Report.
`WorkspaceFolder`	`decomposeAquaMapsItem(String itemId, String folderName, String destinationWorkspaceId)` Decompose the specified AquaMaps item.
`boolean`	`exists(String itemId)` Check if an item with the specified id exists.
`boolean`	`exists(String name, String folderId)` Check if an item with the specified name exists in the specified folder.
`WorkspaceItem`	`find(String path)` Find an item using the specified path.
`WorkspaceItem`	`find(String name, String folderId)` Get an item with the specified name in the specified folder.
`List<WorkspaceSmartFolder>`	`getAllSmartFolders()` Returns all user smart folders
`WorkspaceFolder`	`getApplicationArea()` Get Application Area
`List<Object>`	`getBookmarks(String bookmarkFolderId)` Deprecated.
`Capabilities`	`getCapabilities(String itemId)` Return all capabilities associated with the item.
`long`	`getDiskUsage()` Get the disk usage of a worskpace
`FolderBulkCreatorManager`	`getFolderBulkCreatorManager()` Return this workspace folder bulk creator manager.
`List<SearchItem>`	`getFolderItems(org.gcube.common.homelibary.model.items.type.GenericItemType... types)` Get Folder Items
`List<SearchItem>`	`getFolderItems(org.gcube.common.homelibary.model.items.type.GenericItemType type)` Get items by type
`Home`	`getHome()` Returns the user home.
`WorkspaceItem`	`getItem(String itemId)` Return the item with the specified id.
`WorkspaceItem`	`getItemByPath(String path)` Return the item with the specified path.
`WorkspaceFolder`	`getMySpecialFolders()` Get MySpecialFolders
`FolderBulkCreator`	`getNewFolderBulkCreator(String folderId)` Create a new folderBulkCreator for the specified folder.
`User`	`getOwner()` Returns the workspace owner.
`List<WorkspaceItem>`	`getParentsById(String id)` Get a list of workspaceItem parents by id
`String`	`getPathSeparator()` Returns the item path separator.
`WorkspaceFolder`	`getRoot()` Returns the workspace root.
`WorkspaceSmartFolder`	`getSmartFolder(String folderId)` Get Smart Folder
`int`	`getTotalItems()` Get the total number of items in a workspace
`WorkspaceTrashFolder`	`getTrash()` Get Trash Folder
`String`	`getUrlWebDav()` Get WebDav url
`WorkspaceSharedFolder`	`getVREFolderByScope(String scope)` Get VRE Folder By Scope
`WorkspaceMessageManager`	`getWorkspaceMessageManager()` SendRequest manager.
`List<WorkspaceItem>`	`getWorkspaceTree(WorkspaceItem item)` Get the WorkspaceTree
`boolean`	`isValidName(String name)` Check if the specified name is a valid name.
`WorkspaceItem`	`moveItem(String itemId, String destinationFolderId)` Move a workspaceItem to a specified destination.
`void`	`remove(String itemName, String folderId)` Remove an item from a folder.
`void`	`removeChild(String childId, String folderId)` Remove an item from a folder.
`void`	`removeItem(String itemId)` Remove an item.
`Map<String,String>`	`removeItems(String... id)` Remove a list of items identified by ids
`void`	`renameItem(String itemId, String newName)` Rename an item.
`List<SearchFolderItem>`	`searchByMimeType(String mimeType)` Search By MimeType
`List<SearchItem>`	`searchByName(String name, String folderId)` Search by Name
`List<WorkspaceItem>`	`searchByProperties(List<String> properties)` Search By Properties
`List<SearchFolderItem>`	`searchFullText(String text)` Deprecated.
`List<GCubeItem>`	`searchGCubeItems(SearchQuery query)` Search GCubeItems
`WorkspaceSharedFolder`	`share(List<String> users, String itemId)` Shared an exist `WorkspaceFolder` with a list of users
`WorkspaceSharedFolder`	`shareFolder(List<String> users, String destinationFolderId)` Shared an exist `WorkspaceFolder` with a list of users
`WorkspaceItem`	`unshare(String itemId)` Unshare a shared item
`void`	`updateItem(String itemId, InputStream fileData)` Update an item

Methods inherited from interface org.gcube.common.homelibrary.home.workspace.events.WorkspaceEventSource
addWorkspaceListener, removeWorkspaceListener

Method Detail

getPathSeparator
```
String getPathSeparator()
```
Returns the item path separator.

Returns:
the path separator.

getHome
```
Home getHome()
```
Returns the user home.

Returns:
the home.

getOwner
```
User getOwner()
              throws InternalErrorException
```
Returns the workspace owner.

Returns:
the owner.

Throws:

InternalErrorException - if an internal error occurs.

getRoot
```
WorkspaceFolder getRoot()
```
Returns the workspace root.

Returns:
the root.

Throws:

InternalErrorException

getParentsById
```
List<WorkspaceItem> getParentsById(String id)
                                   throws InternalErrorException
```
Get a list of workspaceItem parents by id

Parameters:
id - the item id

Returns:
a list of parents

Throws:

InternalErrorException

getWorkspaceTree

List<WorkspaceItem> getWorkspaceTree(WorkspaceItem item)
                                     throws InternalErrorException

Get the WorkspaceTree

Parameters:: item -
Returns:: WorkspaceTree
Throws:: InternalErrorException

addBookmark

@Deprecated
void addBookmark(String itemId,
                          String destinationFolderId)
                 throws ItemAlreadyExistException,
                        InternalErrorException,
                        WrongDestinationException,
                        ItemNotFoundException,
                        WorkspaceFolderNotFoundException

Deprecated.

Add a Bookmark

Parameters:: itemId -; destinationFolderId -
Throws:: ItemAlreadyExistException; InternalErrorException; WrongDestinationException; ItemNotFoundException; WorkspaceFolderNotFoundException

getBookmarks

@Deprecated
List<Object> getBookmarks(String bookmarkFolderId)
                          throws InternalErrorException

Deprecated.

Returns all bookmarks

Returns:: a list of bookmarks
Throws:: InternalErrorException

createSmartFolder

WorkspaceSmartFolder createSmartFolder(String name,
                                     String description,
                                     String query,
                                     String folderId)
                                       throws ItemAlreadyExistException,
                                              InternalErrorException

Create a smart folder

Parameters:: name - the smart folder name; description - the smart folder description; query - the term to search; folderId - the folder where to search the query
Returns:: a workspace smart folder
Throws:: ItemAlreadyExistException; InternalErrorException

getAllSmartFolders

List<WorkspaceSmartFolder> getAllSmartFolders()
                                              throws InternalErrorException

Returns all user smart folders

Returns:: a list of WorkspaceSmartFolder
Throws:: InternalErrorException

getSmartFolder

WorkspaceSmartFolder getSmartFolder(String folderId)
                                    throws ItemNotFoundException,
                                           InternalErrorException

Get Smart Folder

Parameters:: folderId -
Returns:: Smart Folder
Throws:: ItemNotFoundException; InternalErrorException

createFolder

WorkspaceFolder createFolder(String name,
                           String description,
                           String destinationFolderId)
                             throws InternalErrorException,
                                    InsufficientPrivilegesException,
                                    ItemAlreadyExistException,
                                    WrongDestinationException,
                                    ItemNotFoundException,
                                    WorkspaceFolderNotFoundException

Create a new folder with specified name. The new folder is created into the specified folder.

Parameters:: name - the folder name.; description - the folder description.; destinationFolderId - the destination folder.
Returns:: the new folder.
Throws:: InternalErrorException - if an internal error occurs.; ItemNotFoundException - if the destination folder has not been found.; InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.; ItemAlreadyExistException - if an item with the same exist in the destination folder.; WrongDestinationException - if the destination item is not a folder.; WorkspaceFolderNotFoundException - if the destination folder has not been found.

createFolder

WorkspaceFolder createFolder(String name,
                           String description,
                           String destinationFolderId,
                           Map<String,String> properties)
                             throws InternalErrorException,
                                    InsufficientPrivilegesException,
                                    ItemAlreadyExistException,
                                    WrongDestinationException,
                                    ItemNotFoundException,
                                    WorkspaceFolderNotFoundException

Create a new folder with properties

Parameters:: name -; description -; destinationFolderId -; properties -
Returns:: the new folder
Throws:: InternalErrorException; InsufficientPrivilegesException; ItemAlreadyExistException; WrongDestinationException; ItemNotFoundException; WorkspaceFolderNotFoundException

createExternalImage

ExternalImage createExternalImage(String name,
                                String description,
                                String mimeType,
                                InputStream imageData,
                                String destinationFolderId)
                                  throws InsufficientPrivilegesException,
                                         WorkspaceFolderNotFoundException,
                                         InternalErrorException,
                                         ItemAlreadyExistException,
                                         WrongDestinationException

Create a new External Image into a folder.

Parameters:: name - the external image name.; description - the external image description.; mimeType - the image mime type.; imageData - the external image data.; destinationFolderId - the destination folder.
Returns:: the new external image.
Throws:: InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.; WorkspaceFolderNotFoundException - if the destination folder has not been found.; InternalErrorException - if an internal error occurs.; ItemAlreadyExistException - if a folder item with same name already exist.; WrongDestinationException - if the destination type is not a folder.

createExternalImage

ExternalImage createExternalImage(String name,
                                String description,
                                String mimeType,
                                InputStream imageData,
                                String destinationFolderId,
                                Map<String,String> properties)
                                  throws InsufficientPrivilegesException,
                                         WorkspaceFolderNotFoundException,
                                         InternalErrorException,
                                         ItemAlreadyExistException,
                                         WrongDestinationException

Create a new External Image with properties

Parameters:: name -; description -; mimeType -; imageData -; destinationFolderId -; properties -
Returns:: the new external image
Throws:: InsufficientPrivilegesException; WorkspaceFolderNotFoundException; InternalErrorException; ItemAlreadyExistException; WrongDestinationException

createExternalFile

ExternalFile createExternalFile(String name,
                              String description,
                              String mimeType,
                              InputStream fileData,
                              String destinationFolderId)
                                throws InsufficientPrivilegesException,
                                       WorkspaceFolderNotFoundException,
                                       InternalErrorException,
                                       ItemAlreadyExistException,
                                       WrongDestinationException

Create a new External File into a folder.

Parameters:: name - the external file name.; description - the external file description.; mimeType - the external file mime type.; fileData - the external file content.; destinationFolderId - the destination folder.
Returns:: the new external file.
Throws:: InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.; WorkspaceFolderNotFoundException - if the destination folder has not been found.; InternalErrorException - if an internal error occurs.; ItemAlreadyExistException - if a folder item with same name already exist.; WrongDestinationException - if the destination type is not a folder.

createExternalFile

ExternalFile createExternalFile(String name,
                              String description,
                              String mimeType,
                              InputStream fileData,
                              String destinationFolderId,
                              Map<String,String> properties)
                                throws InsufficientPrivilegesException,
                                       WorkspaceFolderNotFoundException,
                                       InternalErrorException,
                                       ItemAlreadyExistException,
                                       WrongDestinationException

Create a new External File with properties

Parameters:: name -; description -; mimeType -; fileData -; destinationFolderId -; properties -
Returns:: the new external file
Throws:: InsufficientPrivilegesException; WorkspaceFolderNotFoundException; InternalErrorException; ItemAlreadyExistException; WrongDestinationException

createExternalPDFFile

ExternalPDFFile createExternalPDFFile(String name,
                                    String description,
                                    String mimeType,
                                    InputStream fileData,
                                    String destinationFolderId)
                                      throws InsufficientPrivilegesException,
                                             WorkspaceFolderNotFoundException,
                                             InternalErrorException,
                                             ItemAlreadyExistException,
                                             WrongDestinationException

Create a new External PDF File into a folder.

Parameters:: name - the external PDF file name.; description - the external PDF file description.; mimeType - the external PDF file mime type.; fileData - the external PDF file content.; destinationFolderId - the destination folder.
Returns:: the new external PDF file.
Throws:: InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.; WorkspaceFolderNotFoundException - if the destination folder has not been found.; InternalErrorException - if an internal error occurs.; ItemAlreadyExistException - if a folder item with same name already exist.; WrongDestinationException - if the destination type is not a folder.

createExternalPDFFile

ExternalPDFFile createExternalPDFFile(String name,
                                    String description,
                                    String mimeType,
                                    InputStream fileData,
                                    String destinationFolderId,
                                    Map<String,String> properties)
                                      throws InsufficientPrivilegesException,
                                             WorkspaceFolderNotFoundException,
                                             InternalErrorException,
                                             ItemAlreadyExistException,
                                             WrongDestinationException

Create a new External PDF File with properties

Parameters:: name -; description -; mimeType -; fileData -; destinationFolderId -; properties -
Returns:: the new external pdf file
Throws:: InsufficientPrivilegesException; WorkspaceFolderNotFoundException; InternalErrorException; ItemAlreadyExistException; WrongDestinationException

createExternalUrl

ExternalUrl createExternalUrl(String name,
                            String description,
                            String url,
                            String destinationFolderId)
                              throws InsufficientPrivilegesException,
                                     WorkspaceFolderNotFoundException,
                                     InternalErrorException,
                                     ItemAlreadyExistException,
                                     WrongDestinationException,
                                     IOException

Create a new External URL into a folder.

Parameters:: name - the external URL name.; description - the external URL description.; url - the external URL value.; destinationFolderId - the destination folder.
Returns:: the new external URL.
Throws:: InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.; WorkspaceFolderNotFoundException - if the destination folder has not been found.; InternalErrorException - if an internal error occurs.; ItemAlreadyExistException - if a folder item with same name already exist.; WrongDestinationException - if the destination type is not a folder.; IOException

createExternalUrl

ExternalUrl createExternalUrl(String name,
                            String description,
                            InputStream url,
                            String destinationfolderId)
                              throws InsufficientPrivilegesException,
                                     InternalErrorException,
                                     ItemAlreadyExistException,
                                     WrongDestinationException,
                                     WorkspaceFolderNotFoundException,
                                     IOException

Create a new External URL into a folder.

Parameters:: name - the external URL name.; description - the external URL description.; url - the external URL.; destinationfolderId - the destination folder.
Returns:: the new external URL.
Throws:: InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.; WorkspaceFolderNotFoundException - if the destination folder has not been found.; InternalErrorException - if an internal error occurs.; ItemAlreadyExistException - if a folder item with same name already exist.; WrongDestinationException - if the destination type is not a folder.; IOException

createReportTemplate

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

Create a new Report Template into a 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 content.; destinationfolderId - the destination folder.
Returns:: the new template.
Throws:: InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.; WorkspaceFolderNotFoundException - if the destination folder has not been found.; InternalErrorException - if an internal error occurs.; ItemAlreadyExistException - if a folder item with same name already exist.; WrongDestinationException - if the destination type is not a folder.

createReport

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

Create a new Report into a 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 content.; destinationfolderId - the destination folder.
Returns:: the new report.
Throws:: InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.; WorkspaceFolderNotFoundException - if the destination folder has not been found.; InternalErrorException - if an internal error occurs.; ItemAlreadyExistException - if a folder item with same name already exist.; WrongDestinationException - if the destination type is not a folder.

createQuery

Query createQuery(String name,
                String description,
                String query,
                QueryType queryType,
                String destinationfolderId)
                  throws InsufficientPrivilegesException,
                         InternalErrorException,
                         ItemAlreadyExistException,
                         WrongDestinationException,
                         WorkspaceFolderNotFoundException

Create a new query into a folder.

Parameters:: name - the query name.; description - the query description.; query - the query value.; queryType - the query type.; destinationfolderId - the destination folder.
Returns:: the new query.
Throws:: InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.; WorkspaceFolderNotFoundException - if the destination folder has not been found.; InternalErrorException - if an internal error occurs.; ItemAlreadyExistException - if a folder item with same name already exist.; WrongDestinationException - if the destination type is not a folder.

createQuery

Query createQuery(String name,
                String description,
                InputStream query,
                QueryType queryType,
                String destinationfolderId)
                  throws InsufficientPrivilegesException,
                         InternalErrorException,
                         ItemAlreadyExistException,
                         WrongDestinationException,
                         WorkspaceFolderNotFoundException

Create a new query into a folder.

Parameters:: name - the query name.; description - the query description.; query - the query.; queryType - the query type.; destinationfolderId - the destinatin folder.
Returns:: the new query.
Throws:: InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.; WorkspaceFolderNotFoundException - if the destination folder has not been found.; InternalErrorException - if an internal error occurs.; ItemAlreadyExistException - if a folder item with same name already exist.; WrongDestinationException - if the destination type is not a folder.

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,
                          String destinationfolderId)
                            throws InsufficientPrivilegesException,
                                   InternalErrorException,
                                   ItemAlreadyExistException,
                                   WorkspaceFolderNotFoundException,
                                   WrongDestinationException

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).; destinationfolderId - the time series destination folder.
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.; WorkspaceFolderNotFoundException - if the destination folder has not been found.; WrongDestinationException - if the destination type is not a folder.

removeItem
```
void removeItem(String itemId)
                throws ItemNotFoundException,
                       InternalErrorException,
                       InsufficientPrivilegesException
```
Remove an item.

Parameters:
itemId - the item to remove.

Throws:

ItemNotFoundException - if the item has not been found.

InternalErrorException - if an internal error occurs.

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

moveItem
```
WorkspaceItem moveItem(String itemId,
                     String destinationFolderId)
                       throws ItemNotFoundException,
                              WrongDestinationException,
                              InsufficientPrivilegesException,
                              InternalErrorException,
                              ItemAlreadyExistException,
                              WorkspaceFolderNotFoundException
```
Move a workspaceItem to a specified destination.

Parameters:
itemId - the item to move.
destinationFolderId - the destination folder.

Returns:
the moved workspaceItem

Throws:

ItemNotFoundException - if the specified item has not been found.

WrongDestinationException - if the specified destination has not been found.

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

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if the destination folder have a children with same name.

WorkspaceFolderNotFoundException - if the destination folder is not found.

renameItem

void renameItem(String itemId,
              String newName)
                throws ItemNotFoundException,
                       InternalErrorException,
                       ItemAlreadyExistException,
                       InsufficientPrivilegesException

Rename an item.

Parameters:: itemId - the item id.; newName - the new name.
Throws:: ItemNotFoundException - if the item has not been found.; InternalErrorException - if an internal error occurs.; ItemAlreadyExistException - if the user don't have sufficient privileges to perform this operation.; InsufficientPrivilegesException

changeDescription

void changeDescription(String itemId,
                     String newDescription)
                       throws ItemNotFoundException,
                              InternalErrorException

Change an item description.

Parameters:: itemId - the item to update.; newDescription - the new item description.
Throws:: ItemNotFoundException - if the item has not been found.; InternalErrorException - if an internal error occurs.

getItem
```
WorkspaceItem getItem(String itemId)
                      throws ItemNotFoundException
```
Return the item with the specified id.

Parameters:
itemId - the item id.

Returns:
the item.

Throws:

ItemNotFoundException - if the item has not been found.

getItemByPath
```
WorkspaceItem getItemByPath(String path)
                            throws ItemNotFoundException
```
Return the item with the specified path.

Parameters:
path - the item path.

Returns:
the item.

Throws:

ItemNotFoundException - if the item has not been found.

getCapabilities
```
Capabilities getCapabilities(String itemId)
                             throws ItemNotFoundException,
                                    InternalErrorException
```
Return all capabilities associated with the item.

Parameters:
itemId - the item to retrieve.

Returns:
the capabilities.

Throws:

ItemNotFoundException - if the item has not been found.

InternalErrorException - if an internal error occurs.

removeChild
```
void removeChild(String childId,
               String folderId)
                 throws ItemNotFoundException,
                        InternalErrorException,
                        InsufficientPrivilegesException,
                        WrongParentTypeException
```
Remove an item from a folder.

Parameters:
childId - the item to remove.
folderId - the folder.

Throws:

ItemNotFoundException - if the item has not been found.

InternalErrorException - if an internal error occurs.

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

WrongParentTypeException - if the specified folder is neither a workspace nor a folder.

remove
```
void remove(String itemName,
          String folderId)
            throws ItemNotFoundException,
                   InternalErrorException,
                   InsufficientPrivilegesException,
                   WrongItemTypeException
```
Remove an item from a folder.

Parameters:
itemName - the item name.
folderId - the folder id.

Throws:

ItemNotFoundException - if the folder has not been found.

InternalErrorException - if an internal error occurs.

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

WrongItemTypeException - if the specified folder is neither a workspace nor a folder.

copy
```
WorkspaceItem copy(String itemId,
                 String newName,
                 String destinationFolderId)
                   throws ItemNotFoundException,
                          WrongDestinationException,
                          InternalErrorException,
                          ItemAlreadyExistException,
                          InsufficientPrivilegesException,
                          WorkspaceFolderNotFoundException
```
Copy an item from a folder to another folder.

Parameters:
itemId - the item to copy.
newName - the item new name.
destinationFolderId - the destination folder id.

Returns:
the item copy.

Throws:

ItemNotFoundException - if the item has not been found.

WrongDestinationException - if the destination have a wrong type.

ItemAlreadyExistException - if an item with same name already exist in the destination folder.

InternalErrorException - if an internal error occurs.

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

WorkspaceFolderNotFoundException - if the destination folder has not been found.

copy
```
WorkspaceItem copy(String itemId,
                 String destinationFolderId)
                   throws ItemNotFoundException,
                          WrongDestinationException,
                          InternalErrorException,
                          ItemAlreadyExistException,
                          InsufficientPrivilegesException,
                          WorkspaceFolderNotFoundException
```
Copy an item from a folder to another folder. The item copy have the same name of the original.

Parameters:
itemId - the item to copy.
destinationFolderId - the destination folder id, can't be the same of the item (can't have the same name).

Returns:
the item copy.

Throws:

ItemNotFoundException - if the item has not been found.

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

ItemAlreadyExistException - if an item with same name already exist in the destination folder.

InternalErrorException - if an internal error occurs.

WrongDestinationException - if the destination have a wrong type.

WorkspaceFolderNotFoundException - if the destination folder has not been found.

cloneItem
```
WorkspaceItem cloneItem(String itemId,
                      String cloneName)
                        throws ItemNotFoundException,
                               ItemAlreadyExistException,
                               InsufficientPrivilegesException,
                               InternalErrorException,
                               WrongDestinationException,
                               WorkspaceFolderNotFoundException
```
Clone an item in the same folder. This is a particular version of copy method where the destination folder is the same of original item.

Parameters:
itemId - the item to clone.
cloneName - the clone name.

Returns:
the clone.

Throws:

ItemNotFoundException - if the item has not been found.

ItemAlreadyExistException - if an item with same name already exist in the destination folder.

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

InternalErrorException - if an internal error occurs.

WrongDestinationException - if the destination have a wrong type.

WorkspaceFolderNotFoundException - if the destination folder has not been found.

exists
```
boolean exists(String name,
             String folderId)
               throws InternalErrorException,
                      ItemNotFoundException,
                      WrongItemTypeException
```
Check if an item with the specified name exists in the specified folder.

Parameters:
name - the name to check.
folderId - the folder where to search the item.

Returns:
true if the item exists, false otherwise.

Throws:

InternalErrorException - if an error occurs.

ItemNotFoundException - if the folder has not been found.

WrongItemTypeException - if the folderId referrer to an item with type different from Workspace or folder.

exists
```
boolean exists(String itemId)
               throws InternalErrorException
```
Check if an item with the specified id exists.

Parameters:
itemId - the item id to check.

Returns:
true if the item exists, false otherwise.

Throws:

InternalErrorException - if an error occurs.

find
```
WorkspaceItem find(String name,
                 String folderId)
                   throws InternalErrorException,
                          ItemNotFoundException,
                          WrongItemTypeException
```
Get an item with the specified name in the specified folder.

Parameters:
name - the item name to find.
folderId - the folder where to search the item.

Returns:
the item if the item is found, null otherwise.

Throws:

InternalErrorException - if an error occurs.

ItemNotFoundException - if the folder has not been found.

WrongItemTypeException - if the folderId referrer to an item with type different from Workspace or folder.

find
```
WorkspaceItem find(String path)
                   throws InternalErrorException
```
Find an item using the specified path.

Parameters:
path - the item path.

Returns:
the item if the item is found, null otherwise.

Throws:

InternalErrorException - if an error occurs.

ItemNotFoundException

searchByName

List<SearchItem> searchByName(String name,
                            String folderId)
                              throws InternalErrorException

Search by Name

Parameters:: name -; folderId -
Returns:: a list of SearchItem
Throws:: InternalErrorException

searchByMimeType

List<SearchFolderItem> searchByMimeType(String mimeType)
                                        throws InternalErrorException

Search By MimeType

Parameters:: mimeType -
Returns:: a list of SearchFolderItem
Throws:: InternalErrorException

getFolderItems

List<SearchItem> getFolderItems(org.gcube.common.homelibary.model.items.type.GenericItemType type)
                                throws InternalErrorException

Get items by type

Parameters:: type -
Returns:: a list of SearchItem
Throws:: InternalErrorException

isValidName
```
boolean isValidName(String name)
```
Check if the specified name is a valid name.

Parameters:
name - the name to check.

Returns:
true if the name is valid, false otherwise.

getNewFolderBulkCreator

FolderBulkCreator getNewFolderBulkCreator(String folderId)
                                          throws WorkspaceFolderNotFoundException,
                                                 WrongItemTypeException,
                                                 InternalErrorException

Create a new folderBulkCreator for the specified folder.

Parameters:: folderId - the target folder.
Returns:: a new folderBulkCreator.
Throws:: WorkspaceFolderNotFoundException - if the target folder has not been found.; WrongItemTypeException - if the specified target is not a folder.; InternalErrorException - if an internal error occurs.

getFolderBulkCreatorManager
```
FolderBulkCreatorManager getFolderBulkCreatorManager()
```
Return this workspace folder bulk creator manager.

Returns:
the manager.

getWorkspaceMessageManager
```
WorkspaceMessageManager getWorkspaceMessageManager()
```
SendRequest manager.

Returns:
the manager.

decomposeAquaMapsItem

WorkspaceFolder decomposeAquaMapsItem(String itemId,
                                    String folderName,
                                    String destinationWorkspaceId)
                                      throws WrongItemTypeException,
                                             WorkspaceFolderNotFoundException,
                                             WrongDestinationException,
                                             InternalErrorException,
                                             ItemAlreadyExistException,
                                             InsufficientPrivilegesException,
                                             ItemNotFoundException

Decompose the specified AquaMaps item.

Parameters:: itemId - the aquamaps item id.; folderName - the destination folder name.; destinationWorkspaceId - the destination workspace name.
Returns:: the created folder-
Throws:: WrongItemTypeException - if the specified item is not a GPod item.; WorkspaceFolderNotFoundException - if the specified workspace is not found.; WrongDestinationException - if the specified target is not a workspace.; InternalErrorException - if an internal error occurs.; ItemAlreadyExistException - if a item with that name already exists into the specified workspace.; InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.; ItemNotFoundException - if the aquamaps item has not found.

getFolderItems

List<SearchItem> getFolderItems(org.gcube.common.homelibary.model.items.type.GenericItemType... types)
                                throws InternalErrorException

Get Folder Items

Parameters:: types -
Returns:: a list of SearchItem
Throws:: InternalErrorException

getUrlWebDav
```
String getUrlWebDav()
                    throws InternalErrorException
```
Get WebDav url

Returns:
the WebDav url

Throws:

InternalErrorException

createSharedFolder

WorkspaceSharedFolder createSharedFolder(String name,
                                       String description,
                                       List<String> users,
                                       String destinationFolderId)
                                         throws InternalErrorException,
                                                InsufficientPrivilegesException,
                                                ItemAlreadyExistException,
                                                WrongDestinationException,
                                                ItemNotFoundException,
                                                WorkspaceFolderNotFoundException

Create a shared folder with a list of users

Parameters:: name -; description -; users - A list of portal logins; destinationFolderId -
Returns:: the shared folder
Throws:: InternalErrorException; InsufficientPrivilegesException; ItemAlreadyExistException; WrongDestinationException; ItemNotFoundException; WorkspaceFolderNotFoundException

createSharedFolder

WorkspaceSharedFolder createSharedFolder(String name,
                                       String description,
                                       String groupId,
                                       String destinationFolderId,
                                       String displayName,
                                       boolean isVREFolder)
                                         throws InternalErrorException,
                                                InsufficientPrivilegesException,
                                                ItemAlreadyExistException,
                                                WrongDestinationException,
                                                ItemNotFoundException,
                                                WorkspaceFolderNotFoundException

Create a shared folder associated with a groupId

Parameters:: name - the name of the folder; description -; groupId - an existing groupId to associate with the folder; destinationFolderId -; displayName - a friendly name for the folder; isVREFolder - a flag to indicate the folder is a VRE Folder
Returns:: the shared folder
Throws:: InternalErrorException; InsufficientPrivilegesException; ItemAlreadyExistException; WrongDestinationException; ItemNotFoundException; WorkspaceFolderNotFoundException

shareFolder

WorkspaceSharedFolder shareFolder(List<String> users,
                                String destinationFolderId)
                                  throws InternalErrorException,
                                         InsufficientPrivilegesException,
                                         ItemAlreadyExistException,
                                         WrongDestinationException,
                                         ItemNotFoundException,
                                         WorkspaceFolderNotFoundException

Shared an exist WorkspaceFolder with a list of users

Parameters:: users - A list of portal logins.; destinationFolderId -
Returns:: the shared folder
Throws:: InternalErrorException; InsufficientPrivilegesException; ItemAlreadyExistException; WrongDestinationException; ItemNotFoundException; WorkspaceFolderNotFoundException

WorkspaceSharedFolder share(List<String> users,
                          String itemId)
                            throws InternalErrorException,
                                   InsufficientPrivilegesException,
                                   ItemAlreadyExistException,
                                   WrongDestinationException,
                                   ItemNotFoundException,
                                   WorkspaceFolderNotFoundException

Shared an exist WorkspaceFolder with a list of users

Parameters:: users - A list of portal logins.; itemId -
Returns:: the shared folder
Throws:: InternalErrorException; InsufficientPrivilegesException; ItemAlreadyExistException; WrongDestinationException; ItemNotFoundException; WorkspaceFolderNotFoundException

updateItem

void updateItem(String itemId,
              InputStream fileData)
                throws InsufficientPrivilegesException,
                       WorkspaceFolderNotFoundException,
                       InternalErrorException,
                       ItemAlreadyExistException,
                       WrongDestinationException,
                       ItemNotFoundException

Update an item

Parameters:: itemId -; fileData -
Throws:: InsufficientPrivilegesException; WorkspaceFolderNotFoundException; InternalErrorException; ItemAlreadyExistException; WrongDestinationException; ItemNotFoundException

createGcubeItem

WorkspaceItem createGcubeItem(String name,
                            String description,
                            List<String> scopes,
                            String creator,
                            String itemType,
                            Map<String,String> properties,
                            String destinationFolderId)
                              throws InsufficientPrivilegesException,
                                     WorkspaceFolderNotFoundException,
                                     InternalErrorException,
                                     ItemAlreadyExistException,
                                     WrongDestinationException,
                                     ItemNotFoundException

Create a GCubeItem

Parameters:: name -; description -; scopes -; creator -; itemType -; destinationFolderId -
Returns:: a GCubeItem
Throws:: InsufficientPrivilegesException; WorkspaceFolderNotFoundException; InternalErrorException; ItemAlreadyExistException; WrongDestinationException; ItemNotFoundException

unshare

WorkspaceItem unshare(String itemId)
                      throws InternalErrorException,
                             ItemNotFoundException

Unshare a shared item

Parameters:: itemId -
Throws:: InternalErrorException; ItemNotFoundException

getTrash

WorkspaceTrashFolder getTrash()
                              throws InternalErrorException,
                                     ItemNotFoundException

Get Trash Folder

Returns:: the trash folder
Throws:: ItemNotFoundException; javax.jcr.RepositoryException; InternalErrorException

getMySpecialFolders

WorkspaceFolder getMySpecialFolders()
                                    throws InternalErrorException,
                                           ItemNotFoundException

Get MySpecialFolders

Returns:: my special folders
Throws:: InternalErrorException; ItemNotFoundException

advancedSearch

@Deprecated
List<SearchItem> advancedSearch(String name,
                                         SearchItemByOperator date,
                                         SearchItemByOperator size)
                                throws InternalErrorException

Deprecated.

Advanced Search

Parameters:: name -; date -; size -
Returns:: a list of SearchItem
Throws:: InternalErrorException

searchByProperties

List<WorkspaceItem> searchByProperties(List<String> properties)
                                       throws InternalErrorException

Search By Properties

Parameters:: properties -
Returns:: a list of WorkspaceItem
Throws:: InternalErrorException

searchFullText

@Deprecated
List<SearchFolderItem> searchFullText(String text)
                                      throws InternalErrorException

Deprecated.

Search FullText

Parameters:: text -
Returns:: a list of SearchFolderItem
Throws:: InternalErrorException

getVREFolderByScope

WorkspaceSharedFolder getVREFolderByScope(String scope)
                                          throws ItemNotFoundException,
                                                 InternalErrorException

Get VRE Folder By Scope

Parameters:: scope -
Returns:: the VRE folder associated to such scope
Throws:: ItemNotFoundException; InternalErrorException

createWorkflowReport

WorkflowReport createWorkflowReport(String name,
                                  String description,
                                  String workflowId,
                                  String workflowStatus,
                                  String workflowData,
                                  String destinationfolderId)
                                    throws InsufficientPrivilegesException,
                                           InternalErrorException,
                                           ItemAlreadyExistException,
                                           WorkspaceFolderNotFoundException,
                                           WrongDestinationException

Creates a Workflow Report.

Parameters:: name - the workflow Report name.; description - the workflow Report description.; workflowId - the workflow id.; workflowStatus - the workflow status.; workflowData - the workflow data.; destinationfolderId - the Workflow Report destination folder.
Returns:: the created Workflow 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.; WorkspaceFolderNotFoundException - if the destination folder has not been found.; WrongDestinationException - if the destination type is not a folder.

getDiskUsage
```
long getDiskUsage()
                  throws InternalErrorException
```
Get the disk usage of a worskpace

Returns:
the disk usage

Throws:

InternalErrorException

getTotalItems
```
int getTotalItems()
                  throws InternalErrorException
```
Get the total number of items in a workspace

Returns:
the numer of total Items

Throws:

InternalErrorException

searchGCubeItems

List<GCubeItem> searchGCubeItems(SearchQuery query)
                                 throws InternalErrorException

Search GCubeItems

Parameters:: query -
Returns:: a list of GCubeItem
Throws:: InternalErrorException

getApplicationArea

WorkspaceFolder getApplicationArea()
                                   throws InternalErrorException

Get Application Area

Returns:: Application Area Folder
Throws:: InternalErrorException

removeItems

Map<String,String> removeItems(String... id)
                               throws ItemNotFoundException,
                                      InternalErrorException,
                                      InsufficientPrivilegesException

Remove a list of items identified by ids

Parameters:: id -
Returns:: a map of errors: Map
Throws:: ItemNotFoundException; InternalErrorException; InsufficientPrivilegesException

createVREFolder

WorkspaceVREFolder createVREFolder(String scope,
                                 String description,
                                 String displayName)
                                   throws InternalErrorException,
                                          InsufficientPrivilegesException,
                                          ItemAlreadyExistException,
                                          WrongDestinationException,
                                          ItemNotFoundException,
                                          WorkspaceFolderNotFoundException

Create a VRE folder

Parameters:: scope -; description -; displayName -
Returns:: a new VRE folder
Throws:: InternalErrorException; InsufficientPrivilegesException; ItemAlreadyExistException; WrongDestinationException; ItemNotFoundException; WorkspaceFolderNotFoundException

copyAsLink

WorkspaceInternalLink copyAsLink(String itemId,
                               String destinationFolderId)
                                 throws InternalErrorException

Create a link of a given item in a destination folder

Parameters:: itemId -; destinationFolderId -
Returns:: the link
Throws:: InternalErrorException

Interface Workspace

Method Summary

Methods inherited from interface org.gcube.common.homelibrary.home.workspace.events.WorkspaceEventSource

Method Detail

getPathSeparator

getHome

getOwner

getRoot

getParentsById

getWorkspaceTree

addBookmark

getBookmarks

createSmartFolder

getAllSmartFolders

getSmartFolder

createFolder

createFolder

createExternalImage

createExternalImage

createExternalFile

createExternalFile

createExternalPDFFile

createExternalPDFFile

createExternalUrl

createExternalUrl

createReportTemplate

createReport

createQuery

createQuery

createTimeSeries

removeItem

moveItem

renameItem

changeDescription

getItem

getItemByPath

getCapabilities

removeChild

remove

copy

copy

cloneItem

exists

exists

find

find

searchByName

searchByMimeType

getFolderItems

isValidName

getNewFolderBulkCreator

getFolderBulkCreatorManager

getWorkspaceMessageManager

decomposeAquaMapsItem

getFolderItems

getUrlWebDav

createSharedFolder

createSharedFolder

shareFolder

share

updateItem

createGcubeItem

unshare

getTrash

getMySpecialFolders

advancedSearch

searchByProperties

searchFullText

getVREFolderByScope

createWorkflowReport

getDiskUsage

getTotalItems

searchGCubeItems

getApplicationArea

removeItems

createVREFolder

copyAsLink