org.gcube.portlets.user.homelibrary.home.workspace
Interface WorkspaceArea

All Superinterfaces:
WorkspaceAreaEventSource

public interface WorkspaceArea
extends WorkspaceAreaEventSource

Author:
Federico De Faveri defaveri@isti.cnr.it

Method Summary
 void changeDescription(java.lang.String itemId, java.lang.String newDescription)
          Change an item description.
 WorkspaceAreaItem cloneItem(java.lang.String itemId, java.lang.String cloneName)
          Clone an item in the same folder.
 WorkspaceAreaItem copy(java.lang.String itemId, java.lang.String destinationFolderId)
          Copy an item from a folder to another folder.
 WorkspaceAreaItem copy(java.lang.String itemId, java.lang.String newName, java.lang.String destinationFolderId)
          Copy an item from a folder to another folder.
 Annotation createAnnotation(java.lang.String name, java.lang.String description, java.lang.String oid, java.util.Map<java.lang.String,java.lang.String> data, java.lang.String destinationBasketId)
           
 Basket createBasket(java.lang.String name, java.lang.String description, java.lang.String destinationWorkspaceId)
          Create a new basket in the specified workspace.
 Document createDocument(java.lang.String name, java.lang.String description, java.lang.String oid, java.lang.String mimeType, java.io.InputStream documentData, java.util.Map<java.lang.String,java.lang.String> metadata, java.util.Map<java.lang.String,java.lang.String> annotations, java.lang.String collectionName, java.lang.String destinationBasketId)
          Create a new document into a basket.
 DocumentLink createDocumentLink(java.lang.String name, java.lang.String description, java.lang.String oid, java.util.Map<java.lang.String,java.lang.String> metadata, java.util.Map<java.lang.String,java.lang.String> annotations, java.lang.String collectionName, java.lang.String mimeType, java.lang.String destinationBasketId)
          Create a new document link into a basket.
 ExternalFile createExternalFile(java.lang.String name, java.lang.String description, java.lang.String mimeType, java.io.InputStream fileData, java.lang.String destinationBasketId)
          Create a new External File into a basket.
 ExternalImage createExternalImage(java.lang.String name, java.lang.String description, java.lang.String mimeType, java.io.InputStream imageData, java.lang.String destinationBasketId)
          Create a new External Image into a basket.
 ExternalPDFFile createExternalPDFFile(java.lang.String name, java.lang.String description, java.lang.String mimeType, java.io.InputStream fileData, java.lang.String destinationBasketId)
          Create a new External PDF File into a basket.
 ExternalUrl createExternalUrl(java.lang.String name, java.lang.String description, java.io.InputStream url, java.lang.String destinationBasketId)
          Create a new External Url into a basket.
 ExternalUrl createExternalUrl(java.lang.String name, java.lang.String description, java.lang.String url, java.lang.String destinationBasketId)
          Create a new External Url into a basket.
 ImageDocument createImageDocument(java.lang.String name, java.lang.String description, java.lang.String oid, java.lang.String mimeType, java.io.InputStream imageData, java.util.Map<java.lang.String,java.lang.String> metadata, java.util.Map<java.lang.String,java.lang.String> annotations, java.lang.String collectionName, java.lang.String destinationBasketId)
          Create a new Image Document into a basket.
 ImageDocumentLink createImageDocumentLink(java.lang.String name, java.lang.String description, java.lang.String oid, java.util.Map<java.lang.String,java.lang.String> metadata, java.util.Map<java.lang.String,java.lang.String> annotations, java.lang.String collectionName, java.lang.String mimeType, java.lang.String destinationBasketId)
          Create a new Image Document link into a basket.
 Metadata createMetadata(java.lang.String name, java.lang.String description, java.lang.String oid, java.lang.String schema, java.lang.String language, java.lang.String data, java.lang.String collectionName, java.lang.String destinationBasketId)
          Create a new metadata info object.
 PDFDocument createPDFDocument(java.lang.String name, java.lang.String description, java.lang.String oid, java.lang.String mimeType, java.io.InputStream data, java.util.Map<java.lang.String,java.lang.String> metadata, java.util.Map<java.lang.String,java.lang.String> annotations, java.lang.String collectionName, java.lang.String destinationBasketId)
          Create a new PDF Document into a basket.
 PDFDocumentLink createPDFDocumentLink(java.lang.String name, java.lang.String description, java.lang.String oid, java.util.Map<java.lang.String,java.lang.String> metadata, java.util.Map<java.lang.String,java.lang.String> annotations, java.lang.String collectionName, java.lang.String mimeType, java.lang.String destinationBasketId)
          Create a new PDF Document link into a basket.
 Query createQuery(java.lang.String name, java.lang.String description, java.io.InputStream query, QueryType queryType, java.lang.String destinationBasketId)
          Create a new query into a basket.
 Query createQuery(java.lang.String name, java.lang.String description, java.lang.String query, QueryType queryType, java.lang.String destinationBasketId)
          Create a new query into a basket.
 Report createReport(java.lang.String name, java.lang.String description, java.io.InputStream reportData, java.lang.String destinationBasketId)
          Create a new Report into a basket.
 ReportTemplate createReportTemplate(java.lang.String name, java.lang.String description, java.io.InputStream templateData, java.lang.String destinationBasketId)
          Create a new Report Template into a basket.
 UrlDocument createUrlDocument(java.lang.String name, java.lang.String description, java.lang.String oid, java.lang.String mimeType, java.io.InputStream documentData, java.util.Map<java.lang.String,java.lang.String> metadata, java.util.Map<java.lang.String,java.lang.String> annotations, java.lang.String collectionName, java.lang.String destinationBasketId)
          Create a new url document into a basket.
 Workspace createWorkspace(java.lang.String name, java.lang.String description, java.lang.String destinationWorkspaceId)
          Create a new workspace with specified name.
 boolean exists(java.lang.String name, java.lang.String folderId)
          Check if an item with the specified name exists in the specified folder.
 WorkspaceAreaItem find(java.lang.String name, java.lang.String folderId)
          Get an item with the specified name in the specified folder.
 BasketBulkCreatorManager getBasketBulkCreatorManager()
          Return this workspace area basket bulk creator manager.
 Capabilities getCapabilities(java.lang.String itemId)
          Return all capabilities associated with the item.
 Basket getDefaultBasket()
          Return the default basket.
 Home getHome()
          Return the user home.
 WorkspaceAreaItem getItem(java.lang.String itemId)
          Return the item with the specified id.
 ItemSendRequestManager getItemSendRequestManager()
          SendRequest manager.
 BasketBulkCreator getNewBasketBulkCreator(java.lang.String basketId)
          Create a new BasketBulkCreator for the specified basket.
 User getOwner()
          Return the workspace area owner.
 java.lang.String getPathSeparator()
          Return the item path separator.
 Workspace getRoot()
          Return the workspace root.
 void moveItem(java.lang.String itemId, java.lang.String destinationFolderId)
          Move a workspaceItem to a specified destination.
 void removeChild(java.lang.String childId, java.lang.String folderId)
          Remove an item from a folder.
 void removeItem(java.lang.String itemId)
          Remove an item.
 void renameItem(java.lang.String itemId, java.lang.String newName)
          Rename an item.
 
Methods inherited from interface org.gcube.portlets.user.homelibrary.home.workspace.events.WorkspaceAreaEventSource
addWorkspaceAreaListener, removeWorkspaceAreaListener
 

Method Detail

getPathSeparator

java.lang.String getPathSeparator()
Return the item path separator.

Returns:
the path separator.

getHome

Home getHome()
Return the user home.

Returns:
the home.

getOwner

User getOwner()
Return the workspace area owner.

Returns:
the owner.

getRoot

Workspace getRoot()
Return the workspace root.

Returns:
the root.

getDefaultBasket

Basket getDefaultBasket()
                        throws InternalErrorException
Return the default basket.

Returns:
the default basket.
Throws:
InternalErrorException - if an internal error occurs.

createWorkspace

Workspace createWorkspace(java.lang.String name,
                          java.lang.String description,
                          java.lang.String destinationWorkspaceId)
                          throws InternalErrorException,
                                 InsufficientPrivilegesException,
                                 ItemAlreadyExistException,
                                 WrongDestinationException,
                                 ItemNotFoundException,
                                 WorkspaceNotFoundException
Create a new workspace with specified name. The new workspace is created into the specified workspace.

Parameters:
name - the workspace name. Can't contains slash (/) char.
description - the workspace description.
destinationWorkspaceId - the destination workspace.
Returns:
the new workspace.
Throws:
InternalErrorException - if an internal error occurs.
ItemNotFoundException - if the destination workspace 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 workspace.
WrongDestinationException - if the destination item is not a workspace.
WorkspaceNotFoundException - if the destination workspace has not been found.

createBasket

Basket createBasket(java.lang.String name,
                    java.lang.String description,
                    java.lang.String destinationWorkspaceId)
                    throws InsufficientPrivilegesException,
                           WorkspaceNotFoundException,
                           InternalErrorException,
                           ItemAlreadyExistException,
                           WrongDestinationException
Create a new basket in the specified workspace.

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

createExternalImage

ExternalImage createExternalImage(java.lang.String name,
                                  java.lang.String description,
                                  java.lang.String mimeType,
                                  java.io.InputStream imageData,
                                  java.lang.String destinationBasketId)
                                  throws InsufficientPrivilegesException,
                                         BasketNotFoundException,
                                         InternalErrorException,
                                         ItemAlreadyExistException,
                                         WrongDestinationException
Create a new External Image into a basket.

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

createExternalFile

ExternalFile createExternalFile(java.lang.String name,
                                java.lang.String description,
                                java.lang.String mimeType,
                                java.io.InputStream fileData,
                                java.lang.String destinationBasketId)
                                throws InsufficientPrivilegesException,
                                       BasketNotFoundException,
                                       InternalErrorException,
                                       ItemAlreadyExistException,
                                       WrongDestinationException
Create a new External File into a basket.

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

createExternalPDFFile

ExternalPDFFile createExternalPDFFile(java.lang.String name,
                                      java.lang.String description,
                                      java.lang.String mimeType,
                                      java.io.InputStream fileData,
                                      java.lang.String destinationBasketId)
                                      throws InsufficientPrivilegesException,
                                             BasketNotFoundException,
                                             InternalErrorException,
                                             ItemAlreadyExistException,
                                             WrongDestinationException
Create a new External PDF File into a basket.

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.
destinationBasketId - the destination basket.
Returns:
the new external PDF file.
Throws:
InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.
BasketNotFoundException - if the destination basket has not been found.
InternalErrorException - if an internal error occurs.
ItemAlreadyExistException - if a basket item with same name already exist.
WrongDestinationException - if the destination type is not a basket.

createExternalUrl

ExternalUrl createExternalUrl(java.lang.String name,
                              java.lang.String description,
                              java.lang.String url,
                              java.lang.String destinationBasketId)
                              throws InsufficientPrivilegesException,
                                     BasketNotFoundException,
                                     InternalErrorException,
                                     ItemAlreadyExistException,
                                     WrongDestinationException
Create a new External Url into a basket.

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

createExternalUrl

ExternalUrl createExternalUrl(java.lang.String name,
                              java.lang.String description,
                              java.io.InputStream url,
                              java.lang.String destinationBasketId)
                              throws InsufficientPrivilegesException,
                                     BasketNotFoundException,
                                     InternalErrorException,
                                     ItemAlreadyExistException,
                                     WrongDestinationException
Create a new External Url into a basket.

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

createReportTemplate

ReportTemplate createReportTemplate(java.lang.String name,
                                    java.lang.String description,
                                    java.io.InputStream templateData,
                                    java.lang.String destinationBasketId)
                                    throws InsufficientPrivilegesException,
                                           BasketNotFoundException,
                                           InternalErrorException,
                                           ItemAlreadyExistException,
                                           WrongDestinationException
Create a new Report Template into a basket.

Parameters:
name - the template name.
description - the template description.
templateData - the template content.
destinationBasketId - the destination basket.
Returns:
the new template.
Throws:
InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.
BasketNotFoundException - if the destination basket has not been found.
InternalErrorException - if an internal error occurs.
ItemAlreadyExistException - if a basket item with same name already exist.
WrongDestinationException - if the destination type is not a basket.

createReport

Report createReport(java.lang.String name,
                    java.lang.String description,
                    java.io.InputStream reportData,
                    java.lang.String destinationBasketId)
                    throws InsufficientPrivilegesException,
                           BasketNotFoundException,
                           InternalErrorException,
                           ItemAlreadyExistException,
                           WrongDestinationException
Create a new Report into a basket.

Parameters:
name - the report name.
description - the report description.
reportData - the report content.
destinationBasketId - the destination basket.
Returns:
the new report.
Throws:
InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.
BasketNotFoundException - if the destination basket has not been found.
InternalErrorException - if an internal error occurs.
ItemAlreadyExistException - if a basket item with same name already exist.
WrongDestinationException - if the destination type is not a basket.

createQuery

Query createQuery(java.lang.String name,
                  java.lang.String description,
                  java.lang.String query,
                  QueryType queryType,
                  java.lang.String destinationBasketId)
                  throws InsufficientPrivilegesException,
                         BasketNotFoundException,
                         InternalErrorException,
                         ItemAlreadyExistException,
                         WrongDestinationException
Create a new query into a basket.

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

createQuery

Query createQuery(java.lang.String name,
                  java.lang.String description,
                  java.io.InputStream query,
                  QueryType queryType,
                  java.lang.String destinationBasketId)
                  throws InsufficientPrivilegesException,
                         BasketNotFoundException,
                         InternalErrorException,
                         ItemAlreadyExistException,
                         WrongDestinationException
Create a new query into a basket.

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

createAnnotation

Annotation createAnnotation(java.lang.String name,
                            java.lang.String description,
                            java.lang.String oid,
                            java.util.Map<java.lang.String,java.lang.String> data,
                            java.lang.String destinationBasketId)
                            throws InsufficientPrivilegesException,
                                   BasketNotFoundException,
                                   InternalErrorException,
                                   ItemAlreadyExistException
Throws:
InsufficientPrivilegesException
BasketNotFoundException
InternalErrorException
ItemAlreadyExistException

createMetadata

Metadata createMetadata(java.lang.String name,
                        java.lang.String description,
                        java.lang.String oid,
                        java.lang.String schema,
                        java.lang.String language,
                        java.lang.String data,
                        java.lang.String collectionName,
                        java.lang.String destinationBasketId)
                        throws InsufficientPrivilegesException,
                               BasketNotFoundException,
                               InternalErrorException,
                               ItemAlreadyExistException,
                               WrongDestinationException
Create a new metadata info object.

Parameters:
name - the metadata name.
description - the metadata description.
oid - the metadata oid.
schema - the metadata schema.
language - the metadata language.
data - the metadata data.
collectionName - the metadata referred object collection name.
destinationBasketId - the destination basket.
Returns:
the new metadata.
Throws:
InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.
BasketNotFoundException - if the destination basket has not been found.
InternalErrorException - if an internal error occurs.
ItemAlreadyExistException - if a basket item with same name already exist.
WrongDestinationException - if the destination type is not a basket.

createDocument

Document createDocument(java.lang.String name,
                        java.lang.String description,
                        java.lang.String oid,
                        java.lang.String mimeType,
                        java.io.InputStream documentData,
                        java.util.Map<java.lang.String,java.lang.String> metadata,
                        java.util.Map<java.lang.String,java.lang.String> annotations,
                        java.lang.String collectionName,
                        java.lang.String destinationBasketId)
                        throws InsufficientPrivilegesException,
                               BasketNotFoundException,
                               InternalErrorException,
                               ItemAlreadyExistException,
                               WrongDestinationException
Create a new document into a basket.

Parameters:
name - the document name.
description - the document description.
oid - the document oid (gcube).
mimeType - the document mime type.
documentData - the document content.
metadata - the document associated metadata.
annotations - the document associated annotations.
collectionName - the document's collection name.
destinationBasketId - the destination basket.
Returns:
the new document.
Throws:
InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.
BasketNotFoundException - if the destination basket has not been found.
InternalErrorException - if an internal error occurs.
ItemAlreadyExistException - if a basket item with same name already exist.
WrongDestinationException - if the destination type is not a basket.

createImageDocument

ImageDocument createImageDocument(java.lang.String name,
                                  java.lang.String description,
                                  java.lang.String oid,
                                  java.lang.String mimeType,
                                  java.io.InputStream imageData,
                                  java.util.Map<java.lang.String,java.lang.String> metadata,
                                  java.util.Map<java.lang.String,java.lang.String> annotations,
                                  java.lang.String collectionName,
                                  java.lang.String destinationBasketId)
                                  throws InsufficientPrivilegesException,
                                         BasketNotFoundException,
                                         InternalErrorException,
                                         ItemAlreadyExistException,
                                         WrongDestinationException
Create a new Image Document into a basket.

Parameters:
name - the image document name.
description - the image document description.
oid - the image document oid (gcube).
mimeType - the image document mime type.
imageData - the image document content.
metadata - the image document associated metadata.
annotations - the image document associated annotations.
collectionName - the image document's collection name.
destinationBasketId - the image destination basket.
Returns:
the new image document.
Throws:
InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.
BasketNotFoundException - if the destination basket has not been found.
InternalErrorException - if an internal error occurs.
ItemAlreadyExistException - if a basket item with same name already exist.
WrongDestinationException - if the destination type is not a basket.

createPDFDocument

PDFDocument createPDFDocument(java.lang.String name,
                              java.lang.String description,
                              java.lang.String oid,
                              java.lang.String mimeType,
                              java.io.InputStream data,
                              java.util.Map<java.lang.String,java.lang.String> metadata,
                              java.util.Map<java.lang.String,java.lang.String> annotations,
                              java.lang.String collectionName,
                              java.lang.String destinationBasketId)
                              throws InsufficientPrivilegesException,
                                     BasketNotFoundException,
                                     InternalErrorException,
                                     ItemAlreadyExistException,
                                     WrongDestinationException
Create a new PDF Document into a basket.

Parameters:
name - the pdf document name.
description - the pdf document description.
oid - the pdf document oid (gcube).
mimeType - the pdf document mime type.
data - the pdf document content.
metadata - the pdf document associated metadata.
annotations - the pdf document associated annotations.
collectionName - the pdf document's collection name.
destinationBasketId - the pdf destination basket.
Returns:
the new pdf document.
Throws:
InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.
BasketNotFoundException - if the destination basket has not been found.
InternalErrorException - if an internal error occurs.
ItemAlreadyExistException - if a basket item with same name already exist.
WrongDestinationException - if the destination type is not a basket.

createUrlDocument

UrlDocument createUrlDocument(java.lang.String name,
                              java.lang.String description,
                              java.lang.String oid,
                              java.lang.String mimeType,
                              java.io.InputStream documentData,
                              java.util.Map<java.lang.String,java.lang.String> metadata,
                              java.util.Map<java.lang.String,java.lang.String> annotations,
                              java.lang.String collectionName,
                              java.lang.String destinationBasketId)
                              throws InsufficientPrivilegesException,
                                     BasketNotFoundException,
                                     InternalErrorException,
                                     ItemAlreadyExistException,
                                     WrongDestinationException
Create a new url document into a basket.

Parameters:
name - the document name.
description - the document description.
oid - the document oid (gcube).
mimeType - the document mime type.
documentData - the document content.
metadata - the document associated metadata.
annotations - the document associated annotations.
collectionName - the document's collection name.
destinationBasketId - the destination basket.
Returns:
the new document.
Throws:
InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.
BasketNotFoundException - if the destination basket has not been found.
InternalErrorException - if an internal error occurs.
ItemAlreadyExistException - if a basket item with same name already exist.
WrongDestinationException - if the destination type is not a basket.

createDocumentLink

DocumentLink createDocumentLink(java.lang.String name,
                                java.lang.String description,
                                java.lang.String oid,
                                java.util.Map<java.lang.String,java.lang.String> metadata,
                                java.util.Map<java.lang.String,java.lang.String> annotations,
                                java.lang.String collectionName,
                                java.lang.String mimeType,
                                java.lang.String destinationBasketId)
                                throws InsufficientPrivilegesException,
                                       BasketNotFoundException,
                                       InternalErrorException,
                                       ItemAlreadyExistException,
                                       WrongDestinationException
Create a new document link into a basket.

Parameters:
name - the document name.
description - the document description.
oid - the document oid (gcube).
metadata - the document associated metadata.
annotations - the document associated annotations.
collectionName - the document's collection name.
mimeType - the document mimeType.
destinationBasketId - the destination basket.
Returns:
the new document.
Throws:
InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.
BasketNotFoundException - if the destination basket has not been found.
InternalErrorException - if an internal error occurs.
ItemAlreadyExistException - if a basket item with same name already exist.
WrongDestinationException - if the destination type is not a basket.

createImageDocumentLink

ImageDocumentLink createImageDocumentLink(java.lang.String name,
                                          java.lang.String description,
                                          java.lang.String oid,
                                          java.util.Map<java.lang.String,java.lang.String> metadata,
                                          java.util.Map<java.lang.String,java.lang.String> annotations,
                                          java.lang.String collectionName,
                                          java.lang.String mimeType,
                                          java.lang.String destinationBasketId)
                                          throws InsufficientPrivilegesException,
                                                 BasketNotFoundException,
                                                 InternalErrorException,
                                                 ItemAlreadyExistException,
                                                 WrongDestinationException
Create a new Image Document link into a basket.

Parameters:
name - the image document name.
description - the image document description.
oid - the image document oid (gcube).
metadata - the image document associated metadata.
annotations - the image document associated annotations.
collectionName - the image document's collection name.
mimeType - the image document mimeType.
destinationBasketId - the image destination basket.
Returns:
the new image document.
Throws:
InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.
BasketNotFoundException - if the destination basket has not been found.
InternalErrorException - if an internal error occurs.
ItemAlreadyExistException - if a basket item with same name already exist.
WrongDestinationException - if the destination type is not a basket.

createPDFDocumentLink

PDFDocumentLink createPDFDocumentLink(java.lang.String name,
                                      java.lang.String description,
                                      java.lang.String oid,
                                      java.util.Map<java.lang.String,java.lang.String> metadata,
                                      java.util.Map<java.lang.String,java.lang.String> annotations,
                                      java.lang.String collectionName,
                                      java.lang.String mimeType,
                                      java.lang.String destinationBasketId)
                                      throws InsufficientPrivilegesException,
                                             BasketNotFoundException,
                                             InternalErrorException,
                                             ItemAlreadyExistException,
                                             WrongDestinationException
Create a new PDF Document link into a basket.

Parameters:
name - the pdf document name.
description - the pdf document description.
oid - the pdf document oid (gcube).
metadata - the pdf document associated metadata.
annotations - the pdf document associated annotations.
collectionName - the pdf document's collection name.
mimeType - the pdf document mimeType.
destinationBasketId - the pdf destination basket.
Returns:
the new pdf document.
Throws:
InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.
BasketNotFoundException - if the destination basket has not been found.
InternalErrorException - if an internal error occurs.
ItemAlreadyExistException - if a basket item with same name already exist.
WrongDestinationException - if the destination type is not a basket.

removeItem

void removeItem(java.lang.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

void moveItem(java.lang.String itemId,
              java.lang.String destinationFolderId)
              throws ItemNotFoundException,
                     WrongDestinationException,
                     InsufficientPrivilegesException,
                     InternalErrorException,
                     ItemAlreadyExistException
Move a workspaceItem to a specified destination.

Parameters:
itemId - the item to move.
destinationFolderId - the destination folder.
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.

renameItem

void renameItem(java.lang.String itemId,
                java.lang.String newName)
                throws ItemNotFoundException,
                       InternalErrorException,
                       ItemAlreadyExistException
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.

changeDescription

void changeDescription(java.lang.String itemId,
                       java.lang.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

WorkspaceAreaItem getItem(java.lang.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.

getCapabilities

Capabilities getCapabilities(java.lang.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(java.lang.String childId,
                 java.lang.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 basket.

copy

WorkspaceAreaItem copy(java.lang.String itemId,
                       java.lang.String newName,
                       java.lang.String destinationFolderId)
                       throws ItemNotFoundException,
                              WrongDestinationException,
                              InternalErrorException,
                              ItemAlreadyExistException,
                              InsufficientPrivilegesException
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.

copy

WorkspaceAreaItem copy(java.lang.String itemId,
                       java.lang.String destinationFolderId)
                       throws ItemNotFoundException,
                              WrongDestinationException,
                              InternalErrorException,
                              ItemAlreadyExistException,
                              InsufficientPrivilegesException
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.

cloneItem

WorkspaceAreaItem cloneItem(java.lang.String itemId,
                            java.lang.String cloneName)
                            throws ItemNotFoundException,
                                   ItemAlreadyExistException,
                                   InsufficientPrivilegesException,
                                   InternalErrorException,
                                   WrongDestinationException
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.

exists

boolean exists(java.lang.String name,
               java.lang.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 Basket.

find

WorkspaceAreaItem find(java.lang.String name,
                       java.lang.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 Basket.

getNewBasketBulkCreator

BasketBulkCreator getNewBasketBulkCreator(java.lang.String basketId)
                                          throws BasketNotFoundException,
                                                 WrongItemTypeException,
                                                 InternalErrorException
Create a new BasketBulkCreator for the specified basket.

Parameters:
basketId - the target basket.
Returns:
a new BasketBulkCreator.
Throws:
BasketNotFoundException - if the target basket has not been found.
WrongItemTypeException - if the specified target is not a basket.
InternalErrorException - if an internal error occurs.

getBasketBulkCreatorManager

BasketBulkCreatorManager getBasketBulkCreatorManager()
Return this workspace area basket bulk creator manager.

Returns:
the manager.

getItemSendRequestManager

ItemSendRequestManager getItemSendRequestManager()
SendRequest manager.

Returns:
the manager.