public interface Workspace extends WorkspaceEventSource
| Modifier and Type | Method and Description |
|---|---|
void |
addBookmark(String itemId,
String destinationFolderId)
Add a Bookmark
|
List<SearchItem> |
advancedSearch(String name,
SearchItemByOperator date,
SearchItemByOperator size) |
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.
|
Annotation |
createAnnotation(String name,
String description,
String oid,
Map<String,String> data,
String destinationfolderId)
Create a new annotation.
|
WorkspaceFolder |
createAquaMapsItem(String name,
String description,
String mapName,
String mapType,
String author,
int numberOfSpecies,
String boundingBox,
float psoThreshold,
int numberOfGeneratedImages,
InputStream metadata,
Map<String,InputStream> images,
String destinationfolderId)
Create a new AquaMaps Item into a folder.
|
Document |
createDocument(String name,
String description,
String oid,
String mimeType,
InputStream documentData,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName,
String destinationfolderId)
Create a new document into a folder.
|
DocumentLink |
createDocumentLink(String name,
String description,
String oid,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName,
String mimeType,
String destinationfolderId)
Create a new document link into a folder.
|
ExternalFile |
createExternalFile(String name,
String description,
String mimeType,
File tmpFile,
String destinationFolderId) |
ExternalFile |
createExternalFile(String name,
String description,
String mimeType,
InputStream fileData,
String destinationFolderId)
Create a new External File into a folder.
|
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,
String destinationFolderId,
File tmpFile) |
ExternalPDFFile |
createExternalPDFFile(String name,
String description,
String mimeType,
File tmpFile,
String destinationFolderId)
Create a new External PDF File into a folder.
|
ExternalPDFFile |
createExternalPDFFile(String name,
String description,
String mimeType,
InputStream fileData,
String destinationFolderId)
Create a new External PDF File into a folder.
|
ExternalResourceLink |
createExternalResourceLink(String name,
String description,
String mimeType,
String resourceId,
String pluginName,
String destinationFolderId) |
ExternalUrl |
createExternalUrl(String name,
String description,
File tmpFile,
String destinationFolderId) |
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.
|
WorkspaceItem |
createGcubeItem(String name,
String description,
List<String> scopes,
String creator,
String itemType,
Map<String,String> properties,
String destinationFolderId) |
ImageDocument |
createImageDocument(String name,
String description,
String oid,
String mimeType,
InputStream imageData,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName,
String destinationfolderId)
Create a new Image Document into a folder.
|
ImageDocumentLink |
createImageDocumentLink(String name,
String description,
String oid,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName,
String mimeType,
String destinationfolderId)
Create a new Image Document link into a folder.
|
Metadata |
createMetadata(String name,
String description,
String oid,
String schema,
String language,
String data,
String collectionName,
String destinationfolderId)
Create a new metadata info object.
|
PDFDocument |
createPDFDocument(String name,
String description,
String oid,
String mimeType,
InputStream data,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName,
String destinationfolderId)
Create a new PDF Document into a folder.
|
PDFDocumentLink |
createPDFDocumentLink(String name,
String description,
String oid,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName,
String mimeType,
String destinationfolderId)
Create a new PDF Document link into a folder.
|
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)
Create a smart folder
|
TabularDataLink |
createTabularDataLink(String name,
String description,
String tableId,
String template,
TabularDataLink.Provenance provenance,
String operator,
String runtimeResourceName,
String destinationFolderId) |
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.
|
UrlDocument |
createUrlDocument(String name,
String description,
String oid,
String mimeType,
InputStream documentData,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName,
String destinationfolderId)
Create a new URL document into a folder.
|
WorkflowReport |
createWorkflowReport(String name,
String description,
String workflowId,
String workflowStatus,
String workflowData,
String destinationfolderId)
Creates a Workflow Report.
|
WorkflowTemplate |
createWorkflowTemplate(String name,
String description,
String workflowId,
String workflowStatus,
String workflowData,
String destinationfolderId)
Creates a Workflow Template.
|
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
|
List<Object> |
getBookmarks(String bookmarkFolderId)
Returns all bookmarks
|
Capabilities |
getCapabilities(String itemId)
Return all capabilities associated with the item.
|
long |
getDiskUsage() |
FolderBulkCreatorManager |
getFolderBulkCreatorManager()
Return this workspace folder bulk creator manager.
|
List<SearchItem> |
getFolderItems(FolderItemType... types) |
List<SearchItem> |
getFolderItems(FolderItemType 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.
|
String |
getPathSeparator()
Returns the item path separator.
|
WorkspaceFolder |
getRoot()
Returns the workspace root.
|
WorkspaceSmartFolder |
getSmartFolder(String folderId) |
int |
getTotalItems() |
WorkspaceTrashFolder |
getTrash() |
String |
getUrlWebDav() |
WorkspaceSharedFolder |
getVREFolderByScope(String scope) |
WorkspaceMessageManager |
getWorkspaceMessageManager()
SendRequest manager.
|
List<WorkspaceItem> |
getWorkspaceTree(WorkspaceItem item) |
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 |
orderResultBy(String mimeType,
long limit,
long offset) |
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.
|
void |
renameItem(String itemId,
String newName)
Rename an item.
|
List<SearchFolderItem> |
searchByMimeType(String mimeType) |
List<SearchItem> |
searchByName(String name) |
List<WorkspaceItem> |
searchByProperties(List<String> properties) |
List<SearchFolderItem> |
searchFullText(String text) |
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) |
addWorkspaceListener, removeWorkspaceListenerString getPathSeparator()
Home getHome()
User getOwner() throws InternalErrorException
InternalErrorException - if an internal error occurs.WorkspaceFolder getRoot()
InternalErrorExceptionList<WorkspaceItem> getWorkspaceTree(WorkspaceItem item) throws InternalErrorException
InternalErrorExceptionvoid addBookmark(String itemId, String destinationFolderId) throws ItemAlreadyExistException, InternalErrorException, WrongDestinationException, ItemNotFoundException, WorkspaceFolderNotFoundException
name - folderId - ItemAlreadyExistExceptionInternalErrorExceptionRepositoryExceptionPathNotFoundExceptionWrongDestinationExceptionItemNotFoundExceptionWorkspaceFolderNotFoundExceptionList<Object> getBookmarks(String bookmarkFolderId) throws InternalErrorException
InternalErrorExceptionWorkspaceSmartFolder createSmartFolder(String name, String description, String query) throws ItemAlreadyExistException, InternalErrorException
name - description - query - ItemAlreadyExistExceptionInternalErrorExceptionList<WorkspaceSmartFolder> getAllSmartFolders() throws InternalErrorException
InternalErrorExceptionWorkspaceSmartFolder getSmartFolder(String folderId) throws ItemNotFoundException, InternalErrorException
WorkspaceFolder createFolder(String name, String description, String destinationFolderId) throws InternalErrorException, InsufficientPrivilegesException, ItemAlreadyExistException, WrongDestinationException, ItemNotFoundException, WorkspaceFolderNotFoundException
name - the folder name.description - the folder description.destinationFolderId - the destination folder.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.ExternalImage createExternalImage(String name, String description, String mimeType, InputStream imageData, String destinationFolderId) throws InsufficientPrivilegesException, WorkspaceFolderNotFoundException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException
name - the external image name.description - the external image description.mimeType - the image mime type.imageData - the external image data.destinationFolderId - the destination folder.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.ExternalFile createExternalFile(String name, String description, String mimeType, InputStream fileData, String destinationFolderId) throws InsufficientPrivilegesException, WorkspaceFolderNotFoundException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException
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.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.ExternalPDFFile createExternalPDFFile(String name, String description, String mimeType, File tmpFile, String destinationFolderId) throws InsufficientPrivilegesException, WorkspaceFolderNotFoundException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException
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.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.ExternalPDFFile createExternalPDFFile(String name, String description, String mimeType, InputStream fileData, String destinationFolderId) throws InsufficientPrivilegesException, WorkspaceFolderNotFoundException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException
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.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.ExternalUrl createExternalUrl(String name, String description, String url, String destinationFolderId) throws InsufficientPrivilegesException, WorkspaceFolderNotFoundException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException, IOException
name - the external URL name.description - the external URL description.url - the external URL value.destinationFolderId - the destination folder.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.IOExceptionExternalUrl createExternalUrl(String name, String description, InputStream url, String destinationfolderId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException, WorkspaceFolderNotFoundException, IOException
name - the external URL name.description - the external URL description.url - the external URL.destinationfolderId - the destination folder.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.IOExceptionReportTemplate 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
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.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.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
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.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.Query createQuery(String name, String description, String query, QueryType queryType, String destinationfolderId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException, WorkspaceFolderNotFoundException
name - the query name.description - the query description.query - the query value.queryType - the query type.destinationfolderId - the destination folder.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.Query createQuery(String name, String description, InputStream query, QueryType queryType, String destinationfolderId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException, WorkspaceFolderNotFoundException
name - the query name.description - the query description.query - the query.queryType - the query type.destinationfolderId - the destinatin folder.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.WorkspaceFolder createAquaMapsItem(String name, String description, String mapName, String mapType, String author, int numberOfSpecies, String boundingBox, float psoThreshold, int numberOfGeneratedImages, InputStream metadata, Map<String,InputStream> images, String destinationfolderId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException, WorkspaceFolderNotFoundException
name - the item name.description - the item description.mapName - the map name.mapType - the map type.author - the item author.numberOfSpecies - the number of species selected.boundingBox - the bounding box.psoThreshold - the PSO threshold.numberOfGeneratedImages - the number of generated images.metadata - the item metadata.images - the item images.destinationfolderId - the destination folder.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.Annotation createAnnotation(String name, String description, String oid, Map<String,String> data, String destinationfolderId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WorkspaceFolderNotFoundException
name - the annotation name.description - the annotation description.oid - the annotation oid.data - the annotation data.destinationfolderId - the destination folder id.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.Metadata createMetadata(String name, String description, String oid, String schema, String language, String data, String collectionName, String destinationfolderId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException, WorkspaceFolderNotFoundException
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.destinationfolderId - the destination folder.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.Document createDocument(String name, String description, String oid, String mimeType, InputStream documentData, Map<String,String> metadata, Map<String,String> annotations, String collectionName, String destinationfolderId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException, WorkspaceFolderNotFoundException
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.destinationfolderId - the destination folder.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.ImageDocument createImageDocument(String name, String description, String oid, String mimeType, InputStream imageData, Map<String,String> metadata, Map<String,String> annotations, String collectionName, String destinationfolderId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException, WorkspaceFolderNotFoundException
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.destinationfolderId - the image destination folder.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.PDFDocument createPDFDocument(String name, String description, String oid, String mimeType, InputStream data, Map<String,String> metadata, Map<String,String> annotations, String collectionName, String destinationfolderId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException, WorkspaceFolderNotFoundException
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.destinationfolderId - the PDF destination folder.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.UrlDocument createUrlDocument(String name, String description, String oid, String mimeType, InputStream documentData, Map<String,String> metadata, Map<String,String> annotations, String collectionName, String destinationfolderId) throws InsufficientPrivilegesException, WorkspaceFolderNotFoundException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException
name - the URL document name.description - the URL document description.oid - the URL document oid (gcube).mimeType - the URL document mime type.documentData - the URL document content.metadata - the URL document associated metadata.annotations - the document associated annotations.collectionName - the document's collection name.destinationfolderId - the destination folder.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.DocumentLink createDocumentLink(String name, String description, String oid, Map<String,String> metadata, Map<String,String> annotations, String collectionName, String mimeType, String destinationfolderId) throws InsufficientPrivilegesException, WorkspaceFolderNotFoundException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException
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.destinationfolderId - the destination folder.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.ImageDocumentLink createImageDocumentLink(String name, String description, String oid, Map<String,String> metadata, Map<String,String> annotations, String collectionName, String mimeType, String destinationfolderId) throws InsufficientPrivilegesException, WorkspaceFolderNotFoundException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException
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.destinationfolderId - the image destination folder.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.PDFDocumentLink createPDFDocumentLink(String name, String description, String oid, Map<String,String> metadata, Map<String,String> annotations, String collectionName, String mimeType, String destinationfolderId) throws InsufficientPrivilegesException, WorkspaceFolderNotFoundException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException
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.destinationfolderId - the pdf destination folder.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.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
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.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.WorkflowReport createWorkflowReport(String name, String description, String workflowId, String workflowStatus, String workflowData, String destinationfolderId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WorkspaceFolderNotFoundException, WrongDestinationException
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.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.WorkflowTemplate createWorkflowTemplate(String name, String description, String workflowId, String workflowStatus, String workflowData, String destinationfolderId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WorkspaceFolderNotFoundException, WrongDestinationException
name - the workflow Template name.description - the workflow Template description.workflowId - the workflow id.workflowStatus - the workflow status.workflowData - the workflow data.destinationfolderId - the Workflow Template destination folder.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.void removeItem(String itemId) throws ItemNotFoundException, InternalErrorException, InsufficientPrivilegesException
itemId - the item to remove.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.WorkspaceItem moveItem(String itemId, String destinationFolderId) throws ItemNotFoundException, WrongDestinationException, InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WorkspaceFolderNotFoundException
itemId - the item to move.destinationFolderId - the destination folder.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.void renameItem(String itemId, String newName) throws ItemNotFoundException, InternalErrorException, ItemAlreadyExistException, InsufficientPrivilegesException
itemId - the item id.newName - the new name.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.InsufficientPrivilegesExceptionvoid changeDescription(String itemId, String newDescription) throws ItemNotFoundException, InternalErrorException
itemId - the item to update.newDescription - the new item description.ItemNotFoundException - if the item has not been found.InternalErrorException - if an internal error occurs.WorkspaceItem getItem(String itemId) throws ItemNotFoundException
itemId - the item id.ItemNotFoundException - if the item has not been found.WorkspaceItem getItemByPath(String path) throws ItemNotFoundException
path - the item path.ItemNotFoundException - if the item has not been found.Capabilities getCapabilities(String itemId) throws ItemNotFoundException, InternalErrorException
itemId - the item to retrieve.ItemNotFoundException - if the item has not been found.InternalErrorException - if an internal error occurs.void removeChild(String childId, String folderId) throws ItemNotFoundException, InternalErrorException, InsufficientPrivilegesException, WrongParentTypeException
childId - the item to remove.folderId - the folder.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.void remove(String itemName, String folderId) throws ItemNotFoundException, InternalErrorException, InsufficientPrivilegesException, WrongItemTypeException
itemName - the item name.folderId - the folder id.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.WorkspaceItem copy(String itemId, String newName, String destinationFolderId) throws ItemNotFoundException, WrongDestinationException, InternalErrorException, ItemAlreadyExistException, InsufficientPrivilegesException, WorkspaceFolderNotFoundException
itemId - the item to copy.newName - the item new name.destinationFolderId - the destination folder id.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.WorkspaceItem copy(String itemId, String destinationFolderId) throws ItemNotFoundException, WrongDestinationException, InternalErrorException, ItemAlreadyExistException, InsufficientPrivilegesException, WorkspaceFolderNotFoundException
itemId - the item to copy.destinationFolderId - the destination folder id, can't be the same of the item (can't have the same name).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.WorkspaceItem cloneItem(String itemId, String cloneName) throws ItemNotFoundException, ItemAlreadyExistException, InsufficientPrivilegesException, InternalErrorException, WrongDestinationException, WorkspaceFolderNotFoundException
itemId - the item to clone.cloneName - the clone name.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.boolean exists(String name, String folderId) throws InternalErrorException, ItemNotFoundException, WrongItemTypeException
name - the name to check.folderId - the folder where to search the item.true if the item exists, false otherwise.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.boolean exists(String itemId) throws InternalErrorException
itemId - the item id to check.true if the item exists, false otherwise.InternalErrorException - if an error occurs.WorkspaceItem find(String name, String folderId) throws InternalErrorException, ItemNotFoundException, WrongItemTypeException
name - the item name to find.folderId - the folder where to search the item.null otherwise.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.WorkspaceItem find(String path) throws InternalErrorException
path - the item path.null otherwise.InternalErrorException - if an error occurs.List<SearchItem> searchByName(String name) throws InternalErrorException
InternalErrorExceptionList<SearchFolderItem> searchByMimeType(String mimeType) throws InternalErrorException
mimeType - InternalErrorExceptionList<SearchItem> getFolderItems(FolderItemType type) throws InternalErrorException
InternalErrorExceptionboolean isValidName(String name)
name - the name to check.true if the name is valid, false otherwise.FolderBulkCreator getNewFolderBulkCreator(String folderId) throws WorkspaceFolderNotFoundException, WrongItemTypeException, InternalErrorException
folderId - the target folder.WorkspaceFolderNotFoundException - if the target folder has not been found.WrongItemTypeException - if the specified target is not a folder.InternalErrorException - if an internal error occurs.FolderBulkCreatorManager getFolderBulkCreatorManager()
WorkspaceMessageManager getWorkspaceMessageManager()
WorkspaceFolder decomposeAquaMapsItem(String itemId, String folderName, String destinationWorkspaceId) throws WrongItemTypeException, WorkspaceFolderNotFoundException, WrongDestinationException, InternalErrorException, ItemAlreadyExistException, InsufficientPrivilegesException, ItemNotFoundException
itemId - the aquamaps item id.folderName - the destination folder name.destinationWorkspaceId - the destination workspace name.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.List<SearchItem> getFolderItems(FolderItemType... types) throws InternalErrorException
types - InternalErrorExceptionString getUrlWebDav() throws InternalErrorException
InternalErrorExceptionExternalResourceLink createExternalResourceLink(String name, String description, String mimeType, String resourceId, String pluginName, String destinationFolderId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException, WorkspaceFolderNotFoundException
name - mimeType - resourceId - description - destinationFolderId - plugin - WrongItemTypeExceptionWorkspaceFolderNotFoundExceptionWrongDestinationExceptionInternalErrorExceptionItemAlreadyExistExceptionInsufficientPrivilegesExceptionItemNotFoundExceptionWorkspaceSharedFolder createSharedFolder(String name, String description, List<String> users, String destinationFolderId) throws InternalErrorException, InsufficientPrivilegesException, ItemAlreadyExistException, WrongDestinationException, ItemNotFoundException, WorkspaceFolderNotFoundException
name - description - users. - A list of portal logins.destinationFolderId - InternalErrorExceptionInsufficientPrivilegesExceptionItemAlreadyExistExceptionWrongDestinationExceptionItemNotFoundExceptionWorkspaceFolderNotFoundExceptionWorkspaceSharedFolder createSharedFolder(String name, String description, String groupId, String destinationFolderId, String displayName, boolean isVREFolder) throws InternalErrorException, InsufficientPrivilegesException, ItemAlreadyExistException, WrongDestinationException, ItemNotFoundException, WorkspaceFolderNotFoundException
name - the name of the folderdescription - groupId: - an existing groupId to associate with the folderdestinationFolderId - (not used)diplayName - a friendly name for the folderisVREFolder - a flag to indicate the folder is a VRE FolderInternalErrorExceptionInsufficientPrivilegesExceptionItemAlreadyExistExceptionWrongDestinationExceptionItemNotFoundExceptionWorkspaceFolderNotFoundExceptionWorkspaceSharedFolder shareFolder(List<String> users, String destinationFolderId) throws InternalErrorException, InsufficientPrivilegesException, ItemAlreadyExistException, WrongDestinationException, ItemNotFoundException, WorkspaceFolderNotFoundException
WorkspaceFolder with a list of usersusers. - A list of portal logins.destinationFolderId - InternalErrorExceptionInsufficientPrivilegesExceptionItemAlreadyExistExceptionWrongDestinationExceptionItemNotFoundExceptionWorkspaceFolderNotFoundExceptionTabularDataLink createTabularDataLink(String name, String description, String tableId, String template, TabularDataLink.Provenance provenance, String operator, String runtimeResourceName, String destinationFolderId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException, WorkspaceFolderNotFoundException
name - description - tableId - template - provenance - operator - runtimeResourceName - destinationFolderId - InsufficientPrivilegesExceptionInternalErrorExceptionItemAlreadyExistExceptionWrongDestinationExceptionWorkspaceFolderNotFoundExceptionvoid orderResultBy(String mimeType, long limit, long offset) throws InternalErrorException
mimeType - limit - offset - InternalErrorExceptionvoid updateItem(String itemId, InputStream fileData) throws InsufficientPrivilegesException, WorkspaceFolderNotFoundException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException, ItemNotFoundException
itemId - fileData - InsufficientPrivilegesExceptionWorkspaceFolderNotFoundExceptionInternalErrorExceptionItemAlreadyExistExceptionWrongDestinationExceptionItemNotFoundExceptionWorkspaceItem 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
name - description - scopes - creator - itemType - destinationFolderId - InsufficientPrivilegesExceptionWorkspaceFolderNotFoundExceptionInternalErrorExceptionItemAlreadyExistExceptionWrongDestinationExceptionItemNotFoundExceptionWorkspaceItem unshare(String itemId) throws InternalErrorException, ItemNotFoundException
itemId - InternalErrorExceptionItemNotFoundExceptionWorkspaceTrashFolder getTrash() throws InternalErrorException, ItemNotFoundException
ItemNotFoundExceptionRepositoryExceptionInternalErrorExceptionWorkspaceFolder getMySpecialFolders() throws InternalErrorException, ItemNotFoundException
InternalErrorExceptionItemNotFoundExceptionList<SearchItem> advancedSearch(String name, SearchItemByOperator date, SearchItemByOperator size) throws InternalErrorException
name - date - size - InternalErrorExceptionList<WorkspaceItem> searchByProperties(List<String> properties) throws InternalErrorException
properties - InternalErrorExceptionList<SearchFolderItem> searchFullText(String text) throws InternalErrorException
text - InternalErrorExceptionWorkspaceSharedFolder getVREFolderByScope(String scope) throws ItemNotFoundException, InternalErrorException
scope - ItemNotFoundExceptionInternalErrorExceptionExternalImage createExternalImage(String name, String description, String mimeType, String destinationFolderId, File tmpFile) throws InsufficientPrivilegesException, WorkspaceFolderNotFoundException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException
name - description - mimeType - imageData - destinationFolderId - tmpFile - InsufficientPrivilegesExceptionWorkspaceFolderNotFoundExceptionInternalErrorExceptionItemAlreadyExistExceptionWrongDestinationExceptionExternalUrl createExternalUrl(String name, String description, File tmpFile, String destinationFolderId) throws InsufficientPrivilegesException, WorkspaceFolderNotFoundException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException
name - description - tmpFile - destinationFolderId - InsufficientPrivilegesExceptionWorkspaceFolderNotFoundExceptionInternalErrorExceptionItemAlreadyExistExceptionWrongDestinationExceptionExternalFile createExternalFile(String name, String description, String mimeType, File tmpFile, String destinationFolderId) throws InsufficientPrivilegesException, WorkspaceFolderNotFoundException, InternalErrorException, ItemAlreadyExistException, WrongDestinationException
name - description - mimeType - tmpFile - destinationFolderId - InsufficientPrivilegesExceptionWorkspaceFolderNotFoundExceptionInternalErrorExceptionItemAlreadyExistExceptionWrongDestinationExceptionlong getDiskUsage()
throws InternalErrorException
InternalErrorExceptionint getTotalItems()
throws InternalErrorException
InternalErrorExceptionCopyright © 2015. All Rights Reserved.