public interface WorkspaceFolder extends WorkspaceItem
| Modifier and Type | Method and Description |
|---|---|
ExternalFile |
createExternalFileItem(String name,
String description,
String mimeType,
File fileData)
Create an External File into this folder.
|
ExternalFile |
createExternalFileItem(String name,
String description,
String mimeType,
InputStream fileData)
Create an External File into this folder.
|
FolderItem |
createExternalFileItem(String name,
String description,
String mimeType,
String storageId)
Create an External File into this folder.
|
FolderItem |
createExternalGenericItem(String name,
String description,
InputStream is)
Create a generic item
|
FolderItem |
createExternalGenericItem(String name,
String description,
InputStream is,
Map<String,String> properties)
Create a generic item with properties by inpustream
|
FolderItem |
createExternalGenericItem(String name,
String description,
InputStream is,
Map<String,String> properties,
String mimetype,
long size)
Create a generic item with properties by inpustream
|
FolderItem |
createExternalGenericItem(String name,
String description,
String storageId)
Create a generic item by storage id
|
FolderItem |
createExternalGenericItem(String name,
String description,
String storageId,
Map<String,String> properties)
Create a generic item with properties by storage id
|
FolderItem |
createExternalGenericItem(String name,
String description,
String storageId,
Map<String,String> properties,
String mimeType,
long size)
Create a generic item with properties by storage id
|
FolderItem |
createExternalGenericItem(String name,
String description,
String storageId,
String mimeType)
Create a generic item by storage id and mimetype
|
ExternalImage |
createExternalImageItem(String name,
String description,
String mimeType,
File imageData)
Create a new External Image into this folder.
|
ExternalImage |
createExternalImageItem(String name,
String description,
String mimeType,
InputStream imageData)
Create a new External Image into this folder.
|
ExternalPDFFile |
createExternalPDFFileItem(String name,
String description,
String mimeType,
File tmpFile)
Create a new External PDF file into this folder.
|
ExternalPDFFile |
createExternalPDFFileItem(String name,
String description,
String mimeType,
InputStream fileData)
Create a new External PDF file into this folder.
|
ExternalUrl |
createExternalUrlItem(String name,
String description,
File tmpFile)
Create an External URL into this folder.
|
ExternalUrl |
createExternalUrlItem(String name,
String description,
InputStream url)
Create an External URL into this folder.
|
ExternalUrl |
createExternalUrlItem(String name,
String description,
String url)
Create an External URL into this folder.
|
WorkspaceFolder |
createFolder(String name,
String description)
Create a new folder into this folder.
|
Query |
createQueryItem(String name,
String description,
InputStream query,
QueryType queryType)
Create a new Query into this folder.
|
Query |
createQueryItem(String name,
String description,
String query,
QueryType queryType)
Create a new Query into this folder.
|
Report |
createReportItem(String name,
String description,
Calendar created,
Calendar lastEdit,
String author,
String lastEditBy,
String templateName,
int numberOfSections,
String status,
InputStream reportData)
Create a Report into this folder.
|
ReportTemplate |
createReportTemplateItem(String name,
String description,
Calendar created,
Calendar lastEdit,
String author,
String lastEditBy,
int numberOfSections,
String status,
InputStream templateData)
Create a Report Template into this folder.
|
TimeSeries |
createTimeSeries(String name,
String description,
String timeseriesId,
String title,
String creator,
String timeseriesDescription,
String timeseriesCreationDate,
String publisher,
String sourceId,
String sourceName,
String rights,
long dimension,
List<String> headerLabels,
InputStream compressedCSV)
Create a new Time Series.
|
boolean |
exists(String name)
Check if an item with the specified name exists.
|
WorkspaceItem |
find(String name)
Get an item with the specified name.
|
List<WorkspaceItem> |
getAllChildren(boolean showHidden)
Get children of the current folder
|
List<WorkspaceItem> |
getAllChildren(boolean showHidden,
int limit,
int offset)
Get children of the current folder
|
List<WorkspaceItem> |
getChildren()
Get children of the current folder
|
List<WorkspaceItem> |
getChildren(boolean showHidden)
Get Children with hidden files or not
|
List<WorkspaceItem> |
getChildren(int limit,
int offset,
boolean showHidden)
Get children of a node
|
int |
getChildrenCount(boolean hidden)
Get the number of items in a folder
|
int |
getCount()
Get the number of items in a folder for Storage Manager
|
List<WorkspaceItem> |
getHiddenChildren()
Get hidden children of the current folder
|
List<WorkspaceItem> |
getLastItems(int limit)
Get items ordered by jcr:lastModified
|
FolderBulkCreator |
getNewFolderBulkCreator()
Create a new FolderBulkCreator for this folder.
|
long |
getSize()
Get the size of a folder
|
String |
getUniqueName(String initialName,
boolean copy)
Get Unique name
|
boolean |
isPublic()
Check if the folder is public
|
boolean |
isSystemFolder()
Check if a folder is a system folder
|
void |
setACL(List<String> users,
ACLType privilege)
Set a privilege to a list of users
|
void |
setPublic(boolean flag)
Set a folder as public or private
|
void |
setSystemFolder(boolean systemFolder)
Mark folder as system folder
|
WorkspaceSharedFolder |
share(List<String> users)
Share a folder
|
cloneItem, deleteACL, getAccounting, getACLOwner, getACLUser, getCreationTime, getDescription, getId, getIdSharedFolder, getLastAction, getLastModificationTime, getLastUpdatedBy, getName, getOwner, getParent, getPath, getProperties, getPublicLink, getReaders, getRemotePath, getSecurePublicLink, getStorageID, getType, hasAccessRight, isFolder, isHidden, isMarkedAsRead, isRoot, isShared, isTrashed, markAsRead, move, remove, removeChild, rename, setDescription, setHidden, updateItemList<WorkspaceItem> getAllChildren(boolean showHidden) throws InternalErrorException
showHidden: - true to include hidden folders; false otherwise.InternalErrorException - if an error occurs.List<WorkspaceItem> getAllChildren(boolean showHidden, int limit, int offset) throws InternalErrorException
showHidden: - true to include hidden folders; false otherwise.limit - is used to limit the number of results returned.offset - says to skip that many items before beginning to return items. OFFSET 0 is the same as omitting the OFFSET clause.InternalErrorException - if an error occurs.List<WorkspaceItem> getChildren() throws InternalErrorException
getChildren in interface WorkspaceItemInternalErrorException - if an error occurs.List<WorkspaceItem> getChildren(int limit, int offset, boolean showHidden) throws InternalErrorException
limit - is used to limit the number of results returned.offset - says to skip that many items before beginning to return items. If OFFSET < 1, OFFSET parameter will be ignored.showHidden - if true, hidden files are included in the result set.InternalErrorExceptionList<WorkspaceItem> getHiddenChildren() throws InternalErrorException
InternalErrorExceptionboolean 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.ExternalImage createExternalImageItem(String name, String description, String mimeType, File 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, File 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, File tmpFile) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException
name - the external PDF name.description - the external PDF description.mimeType - the external PDF mime type.tmpFile - the PDF tmpFileInsufficientPrivilegesException - 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, File tmpFile) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException
name - the external URL name.description - the external URL description.tmpFile - a temporary fileInsufficientPrivilegesExceptionInternalErrorExceptionItemAlreadyExistExceptionFolderItem createExternalFileItem(String name, String description, String mimeType, String storageId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException
name - the external file name.description - the external file description.mimeType - the external file mime type.storageId - the storage ID used to save temporarily the fileInsufficientPrivilegesException - 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.IOExceptionExternalUrl 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.IOExceptionReportTemplate 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.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.FolderBulkCreator getNewFolderBulkCreator() throws InternalErrorException
InternalErrorException - if an internal error occurs.WorkspaceSharedFolder share(List<String> users) throws InsufficientPrivilegesException, WrongDestinationException, InternalErrorException
users - A list of usersInsufficientPrivilegesExceptionWrongDestinationExceptionInternalErrorExceptionvoid setACL(List<String> users, ACLType privilege) throws InternalErrorException
users - privilege - InternalErrorExceptionlong getSize()
throws InternalErrorException
InternalErrorExceptionint getCount()
throws InternalErrorException
InternalErrorExceptionint getChildrenCount(boolean hidden)
throws InternalErrorException
hidden - if true, includeInternalErrorExceptionList<WorkspaceItem> getLastItems(int limit) throws InternalErrorException
limit - The maximum result sizeInternalErrorExceptionFolderItem createExternalGenericItem(String name, String description, InputStream is) throws InternalErrorException, InsufficientPrivilegesException, ItemAlreadyExistException
name - description - mimeType - is - InternalErrorExceptionItemAlreadyExistExceptionInsufficientPrivilegesExceptionFolderItem createExternalGenericItem(String name, String description, InputStream is, Map<String,String> properties) throws InternalErrorException, InsufficientPrivilegesException, ItemAlreadyExistException
name - description - is - properties - InternalErrorExceptionInsufficientPrivilegesExceptionItemAlreadyExistExceptionFolderItem createExternalGenericItem(String name, String description, InputStream is, Map<String,String> properties, String mimetype, long size) throws InternalErrorException, InsufficientPrivilegesException, ItemAlreadyExistException
name - description - is - properties - mimetype - size - InternalErrorExceptionInsufficientPrivilegesExceptionItemAlreadyExistExceptionFolderItem createExternalGenericItem(String name, String description, String storageId) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException
name - description - storageId - InsufficientPrivilegesExceptionInternalErrorExceptionItemAlreadyExistExceptionFolderItem createExternalGenericItem(String name, String description, String storageId, String mimeType) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException
name - description - storageId - mimeType - InsufficientPrivilegesExceptionInternalErrorExceptionItemAlreadyExistExceptionFolderItem createExternalGenericItem(String name, String description, String storageId, Map<String,String> properties) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException
name - description - mimeType - storageId - properties - InsufficientPrivilegesExceptionInternalErrorExceptionItemAlreadyExistExceptionFolderItem createExternalGenericItem(String name, String description, String storageId, Map<String,String> properties, String mimeType, long size) throws InsufficientPrivilegesException, InternalErrorException, ItemAlreadyExistException
name - description - mimeType - storageId - properties - InsufficientPrivilegesExceptionInternalErrorExceptionItemAlreadyExistExceptionvoid setSystemFolder(boolean systemFolder)
throws InternalErrorException
systemFolder - InternalErrorExceptionboolean isSystemFolder()
throws InternalErrorException
InternalErrorExceptionList<WorkspaceItem> getChildren(boolean showHidden) throws InternalErrorException
showHidden - to show hidden filesInternalErrorExceptionboolean isPublic()
throws InternalErrorException
InternalErrorExceptionvoid setPublic(boolean flag)
throws InternalErrorException,
InsufficientPrivilegesException
flag - true to set the folder as public, false to deny public accessInternalErrorExceptionInsufficientPrivilegesExceptionString getUniqueName(String initialName, boolean copy) throws InternalErrorException
initialName - copy - InternalErrorExceptionCopyright © 2020. All Rights Reserved.