|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface WorkspaceFolder
| Method Summary | |
|---|---|
Annotation |
createAnnotationItem(String name,
String description,
String oid,
Map<String,String> data)
Create a new annotation into this 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)
Create a new AquaMaps Item into this folder. |
Document |
createDocumentItem(String name,
String description,
String oid,
String mimeType,
InputStream documentData,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName)
Create a new document into this folder. |
DocumentLink |
createDocumentLinkItem(String name,
String description,
String oid,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName,
String mimeType)
Create a new document link into this folder. |
ExternalFile |
createExternalFileItem(String name,
String description,
String mimeType,
InputStream fileData)
Create an External File into this folder. |
ExternalImage |
createExternalImageItem(String name,
String description,
String mimeType,
InputStream imageData)
Create a new External Image into this folder. |
ExternalPDFFile |
createExternalPDFFileItem(String name,
String description,
String mimeType,
InputStream fileData)
Create a new External PDF file into this folder. |
ExternalResourceLink |
createExternalResourceLink(String name,
String description,
String mimeType,
String resourceIdString,
String pluginName)
|
ExternalUrl |
createExternalUrlItem(String name,
String description,
InputStream url)
Create an External URL into this folder. |
ExternalUrl |
createExternalUrlItem(String name,
String description,
String url)
Create an External URL into this folder. |
WorkspaceFolder |
createFolder(String name,
String description)
Create a new folder into this folder. |
ImageDocument |
createImageDocumentItem(String name,
String description,
String oid,
String mimeType,
InputStream imageData,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName)
Create a new image document into this folder. |
ImageDocumentLink |
createImageDocumentLinkItem(String name,
String description,
String oid,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName,
String mimeType)
Create a new image document link into this folder. |
Metadata |
createMetadataItem(String name,
String description,
String oid,
String schema,
String language,
String metadata,
String collectionName)
Create a new Metadata into this folder. |
PDFDocument |
createPDFDocumentItem(String name,
String description,
String oid,
String mimeType,
InputStream data,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName)
Create a new PDF document. |
PDFDocumentLink |
createPDFDocumentLinkItem(String name,
String description,
String oid,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName,
String mimeType)
Create a new PDF document link. |
Query |
createQueryItem(String name,
String description,
InputStream query,
QueryType queryType)
Create a new Query into this folder. |
Query |
createQueryItem(String name,
String description,
String query,
QueryType queryType)
Create a new Query into this folder. |
Report |
createReportItem(String name,
String description,
Calendar created,
Calendar lastEdit,
String author,
String lastEditBy,
String templateName,
int numberOfSections,
String status,
InputStream reportData)
Create a Report into this folder. |
ReportTemplate |
createReportTemplateItem(String name,
String description,
Calendar created,
Calendar lastEdit,
String author,
String lastEditBy,
int numberOfSections,
String status,
InputStream templateData)
Create a Report Template into this folder. |
TimeSeries |
createTimeSeries(String name,
String description,
String timeseriesId,
String title,
String creator,
String timeseriesDescription,
String timeseriesCreationDate,
String publisher,
String sourceId,
String sourceName,
String rights,
long dimension,
List<String> headerLabels,
InputStream compressedCSV)
Create a new Time Series. |
UrlDocument |
createUrlDocumentItem(String name,
String description,
String oid,
String mimeType,
InputStream documentData,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName)
Create a new URL document into this folder. |
WorkflowReport |
createWorkflowReport(String name,
String description,
String workflowId,
String workflowStatus,
String workflowData)
Creates a Workflow Report. |
WorkflowTemplate |
createWorkflowTemplate(String name,
String description,
String workflowId,
String workflowStatus,
String workflowData)
Creates a Workflow Template. |
boolean |
exists(String name)
Check if an item with the specified name exists. |
WorkspaceItem |
find(String name)
Get an item with the specified name. |
List<WorkspaceItem> |
getChildren()
Return this item children. |
FolderBulkCreator |
getNewFolderBulkCreator()
Create a new FolderBulkCreator for this folder. |
WorkspaceSharedFolder |
share(List<String> useers)
|
| Methods inherited from interface org.gcube.portlets.user.homelibrary.home.workspace.WorkspaceItem |
|---|
cloneItem, getAccounting, getCapabilities, getCreationTime, getDescription, getId, getLastAction, getLastModificationTime, getName, getOwner, getParent, getPath, getProperties, getType, isMarkedAsRead, isRoot, isShared, markAsRead, move, remove, removeChild, rename, setDescription |
| Method Detail |
|---|
List<WorkspaceItem> getChildren()
throws InternalErrorException
getChildren in interface WorkspaceItemInternalErrorException - if an internal error occurs.
boolean exists(String name)
throws InternalErrorException
name - the name to check.
true if the item exists, false otherwise.
InternalErrorException - if an error occurs.
WorkspaceItem find(String name)
throws InternalErrorException
name - the item name to find.
null otherwise.
InternalErrorException - if an error occurs.
WorkspaceFolder createFolder(String name,
String description)
throws InternalErrorException,
InsufficientPrivilegesException,
ItemAlreadyExistException
name - the folder name.description - the folder description.
InternalErrorException - if an internal error occurs.
InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.
ItemAlreadyExistException - if an item with the specified name already exists in this folder.
ExternalImage createExternalImageItem(String name,
String description,
String mimeType,
InputStream imageData)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the external image name.description - the external image description.mimeType - the external image mime type.imageData - the external image data.
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.
ExternalFile createExternalFileItem(String name,
String description,
String mimeType,
InputStream fileData)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the external file name.description - the external file description.mimeType - the external file mime type.fileData - the external file data.
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.
ExternalPDFFile createExternalPDFFileItem(String name,
String description,
String mimeType,
InputStream fileData)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the external PDF name.description - the external PDF description.mimeType - the external PDF mime type.fileData - the external PDF data.
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.
ExternalUrl createExternalUrlItem(String name,
String description,
String url)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the external URL name.description - the external URL description.url - the URL.
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.
ExternalUrl createExternalUrlItem(String name,
String description,
InputStream url)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the external URL name.description - the external URL description.url - the URL.
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.
ReportTemplate createReportTemplateItem(String name,
String description,
Calendar created,
Calendar lastEdit,
String author,
String lastEditBy,
int numberOfSections,
String status,
InputStream templateData)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the template name.description - the template description.created - the template creation time.lastEdit - the last edit time.author - the template author.lastEditBy - the last template editor.numberOfSections - the number of sections.status - the template status.templateData - the template data.
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.
Report createReportItem(String name,
String description,
Calendar created,
Calendar lastEdit,
String author,
String lastEditBy,
String templateName,
int numberOfSections,
String status,
InputStream reportData)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the report name.description - the report description.created - the report creation time.lastEdit - the last edit time.author - the report author.lastEditBy - the last report editor.templateName - the source template name.numberOfSections - the number of sections.status - the report status.reportData - the report data.
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.
Query createQueryItem(String name,
String description,
String query,
QueryType queryType)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the query name.description - the query description.query - the query.queryType - the query type.
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.
Query createQueryItem(String name,
String description,
InputStream query,
QueryType queryType)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the query name.description - the query description.query - the query.queryType - the query type.
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.
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)
throws InsufficientPrivilegesException,
WorkspaceFolderNotFoundException,
InternalErrorException,
ItemAlreadyExistException,
WrongDestinationException
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.
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 createAnnotationItem(String name,
String description,
String oid,
Map<String,String> data)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the annotation name.description - the annotation description.oid - the oid of the object where the annotation come from.data - the annotation data.
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.
Metadata createMetadataItem(String name,
String description,
String oid,
String schema,
String language,
String metadata,
String collectionName)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the metadata name.description - the metadata description.oid - the oid of the object where the metadata come from.schema - the metadata schema.language - the metadata language.metadata - the metadata data.collectionName - the metadata referred object collection name.
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.
Document createDocumentItem(String name,
String description,
String oid,
String mimeType,
InputStream documentData,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the document name.description - the document description.oid - the document oid.mimeType - the document mime type.documentData - the document data.metadata - the document metadata.annotations - the document annotations.collectionName - the document collection name.
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.
ImageDocument createImageDocumentItem(String name,
String description,
String oid,
String mimeType,
InputStream imageData,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the document image name.description - the document image description.oid - the document image oid.mimeType - the image document mime type.imageData - the document image data.metadata - the document image metadata.annotations - the document image annotations.collectionName - the document image collection name.
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.
PDFDocument createPDFDocumentItem(String name,
String description,
String oid,
String mimeType,
InputStream data,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the PDF document name.description - the document PDF description.oid - the document PDF oid.mimeType - the document PDF mime type.data - the document PDF data.metadata - the document PDF metadata.annotations - the document PDF annotations.collectionName - the document collection name.
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.
UrlDocument createUrlDocumentItem(String name,
String description,
String oid,
String mimeType,
InputStream documentData,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the document name.description - the document description.oid - the document oid.mimeType - the document mimeType.documentData - the document data.metadata - the document metadata.annotations - the document annotations.collectionName - the document collection name.
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.
DocumentLink createDocumentLinkItem(String name,
String description,
String oid,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName,
String mimeType)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the document name.description - the document description.oid - the document oid.metadata - the document metadata.annotations - the document annotations.collectionName - the document collection name.mimeType - the document mimeType.
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.
ImageDocumentLink createImageDocumentLinkItem(String name,
String description,
String oid,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName,
String mimeType)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the document image name.description - the document image description.oid - the document image oid.metadata - the document image metadata.annotations - the document image annotations.collectionName - the document image collection name.mimeType - the image document mimeType.
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.
PDFDocumentLink createPDFDocumentLinkItem(String name,
String description,
String oid,
Map<String,String> metadata,
Map<String,String> annotations,
String collectionName,
String mimeType)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the pdf document name.description - the document pdf description.oid - the document pdf oid.metadata - the document pdf metadata.annotations - the document pdf annotations.collectionName - the document collection name.mimeType - the pdf document mimeType.
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.
TimeSeries createTimeSeries(String name,
String description,
String timeseriesId,
String title,
String creator,
String timeseriesDescription,
String timeseriesCreationDate,
String publisher,
String sourceId,
String sourceName,
String rights,
long dimension,
List<String> headerLabels,
InputStream compressedCSV)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
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).
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.
WorkflowReport createWorkflowReport(String name,
String description,
String workflowId,
String workflowStatus,
String workflowData)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the workflow Report name.description - the workflow Report description.workflowId - the workflow id.workflowStatus - the workflow status.workflowData - the workflow data.
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)
throws InsufficientPrivilegesException,
InternalErrorException,
ItemAlreadyExistException
name - the workflow Template name.description - the workflow Template description.workflowId - the workflow id.workflowStatus - the workflow status.workflowData - the workflow data.
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.
FolderBulkCreator getNewFolderBulkCreator()
throws InternalErrorException
InternalErrorException - if an internal error occurs.
ExternalResourceLink createExternalResourceLink(String name,
String description,
String mimeType,
String resourceIdString,
String pluginName)
throws InternalErrorException,
ItemAlreadyExistException,
InsufficientPrivilegesException
name - description - mimeType - resourceIdString - pluginName -
WrongItemTypeException
WorkspaceFolderNotFoundException
WrongDestinationException
InternalErrorException
ItemAlreadyExistException
InsufficientPrivilegesException
ItemNotFoundException
WorkspaceSharedFolder share(List<String> useers)
throws InsufficientPrivilegesException,
WrongDestinationException,
InternalErrorException
InsufficientPrivilegesException
WrongDestinationException
InternalErrorException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||