public interface WorkspaceItem
| Modifier and Type | Method and Description |
|---|---|
WorkspaceItem |
cloneItem(String cloneName)
Clone this item.
|
void |
deleteACL(List<String> users)
Delete ACL for a list of users
|
List<AccountingEntry> |
getAccounting() |
Map<ACLType,List<String>> |
getACLOwner()
Get a map of ACL of a WorkspaceSharedFolder
|
ACLType |
getACLUser()
Get the ACL of a WorkspaceSharedFolder
|
List<? extends WorkspaceItem> |
getChildren()
Return this item children.
|
Calendar |
getCreationTime()
This item creation time.
|
String |
getDescription()
This item description.
|
String |
getId()
This item id.
|
String |
getIdSharedFolder()
Get the id of the parent shared folder
|
org.gcube.common.homelibary.model.util.WorkspaceItemAction |
getLastAction()
Return the last action on this Item.
|
Calendar |
getLastModificationTime()
This item last modification time.
|
String |
getLastUpdatedBy()
Return last updated by
|
String |
getName()
This item name.
|
User |
getOwner()
This item owner.
|
WorkspaceFolder |
getParent()
Return this item parent.
|
String |
getPath()
Return the current item path.
|
Properties |
getProperties()
The item properties.
|
String |
getPublicLink(boolean shortUrl)
Get a public link for the item
|
List<AccountingEntryRead> |
getReaders()
Get a list of item readers.
|
String |
getRemotePath()
Get the remote path of the element
|
String |
getSecurePublicLink(boolean shortenUrl)
Get a secure (i.e.
|
String |
getStorageID()
Get a storageId
|
org.gcube.common.homelibary.model.items.type.WorkspaceItemType |
getType()
Return this item type.
|
boolean |
hasAccessRight(String user,
String absPath)
Return true if the user has the right to read the resource at abspath
|
boolean |
isFolder()
Check if the item is a folder
|
boolean |
isHidden()
Return a flag indicating whether the element is hidden
|
boolean |
isMarkedAsRead()
Return a flag indicating whether the element marked as read
|
boolean |
isRoot()
Says if this item is a root element.
|
boolean |
isShared()
Return a flag indicating whether the element is shared
|
boolean |
isTrashed()
Check if the item is in the trash
|
void |
markAsRead(boolean read)
Mark as read a shared item
|
void |
move(WorkspaceFolder destination)
Move this item to a new folder.
|
void |
remove()
Remove this item from the workspace.
|
void |
removeChild(WorkspaceItem child)
Remove a child from this item.
|
void |
rename(String name)
Change this item name.
|
void |
setDescription(String description)
Set a new item description.
|
void |
setHidden(boolean flag)
Mark items as hidden
|
void |
updateItem(InputStream fileData)
Update item
|
String getId() throws InternalErrorException
InternalErrorException - if an internal error occurs.String getName() throws InternalErrorException
InternalErrorException - if an internal error occurs.String getDescription() throws InternalErrorException
InternalErrorException - if an internal error occurs.void setDescription(String description) throws InternalErrorException
description - the new description.InternalErrorException - if an internal error occurs.void rename(String name) throws InternalErrorException, InsufficientPrivilegesException, ItemAlreadyExistException
name - the new name.InternalErrorException - if an internal error occurs.InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.ItemAlreadyExistException - if an item with this name already exists in the containing folder.Calendar getCreationTime() throws InternalErrorException
InternalErrorException - if an internal error occurs.Calendar getLastModificationTime() throws InternalErrorException
InternalErrorException - if an internal error occurs.String getLastUpdatedBy() throws InternalErrorException
InternalErrorExceptionorg.gcube.common.homelibary.model.util.WorkspaceItemAction getLastAction()
throws InternalErrorException
InternalErrorException - if an internal error occurs.User getOwner() throws InternalErrorException
InternalErrorException - if an internal error occurs.Properties getProperties() throws InternalErrorException
InternalErrorException - if an internal error occurs.List<AccountingEntry> getAccounting()
org.gcube.common.homelibary.model.items.type.WorkspaceItemType getType()
WorkspaceFolder getParent() throws InternalErrorException
InternalErrorException - if an internal error occurs.String getPath() throws InternalErrorException
InternalErrorException - if an internal error occurs.boolean isRoot()
throws InternalErrorException
true if this element is a root, false otherwise.InternalErrorException - if an internal error occurs.List<? extends WorkspaceItem> getChildren() throws InternalErrorException
InternalErrorException - if an internal error occurs.void removeChild(WorkspaceItem child) throws InternalErrorException, InsufficientPrivilegesException
child - the child to remove.InternalErrorException - if an internal error occurs.InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.void remove()
throws InternalErrorException,
InsufficientPrivilegesException
InternalErrorException - if an internal error occurs.InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.void move(WorkspaceFolder destination) throws InternalErrorException, WrongDestinationException, InsufficientPrivilegesException, ItemAlreadyExistException
destination - the destination folder.InternalErrorException - if an internal error occurs.WrongDestinationException - if the destination folder have a wrong type.InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.ItemAlreadyExistException - if an item with the new name already exist in the destination folder.WorkspaceItem cloneItem(String cloneName) throws InternalErrorException, InsufficientPrivilegesException, ItemAlreadyExistException
cloneName - the new clone name.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 new name already exist.void setHidden(boolean flag)
throws InternalErrorException
flag - true if the element is hidden, false if the element is visible.InternalErrorExceptionboolean isHidden()
throws InternalErrorException
true if the element is hidden, false if the element is visible.InternalErrorExceptionboolean isShared()
throws InternalErrorException
true if the element is shared, false otherwise.InternalErrorExceptionboolean isMarkedAsRead()
throws InternalErrorException
true if the element is marked as read, false otherwise.InternalErrorExceptionList<AccountingEntryRead> getReaders() throws InternalErrorException
InternalErrorExceptionvoid markAsRead(boolean read)
throws InternalErrorException
InternalErrorExceptionString getIdSharedFolder() throws InternalErrorException
InternalErrorExceptionString getRemotePath() throws InternalErrorException
InternalErrorExceptionboolean isTrashed()
throws InternalErrorException
InternalErrorExceptionboolean isFolder()
throws InternalErrorException
InternalErrorExceptionString getPublicLink(boolean shortUrl) throws InternalErrorException
shortenUrl - InternalErrorExceptionString getSecurePublicLink(boolean shortenUrl) throws InternalErrorException
shortenUrl - InternalErrorExceptionString getStorageID() throws InternalErrorException
InternalErrorExceptionboolean hasAccessRight(String user, String absPath) throws InternalErrorException
user - absPath: - absolute path of a nodejavax.jcr.RepositoryExceptionInternalErrorExceptionvoid deleteACL(List<String> users) throws InternalErrorException
users - InternalErrorExceptionACLType getACLUser() throws InternalErrorException
InternalErrorExceptionMap<ACLType,List<String>> getACLOwner() throws InternalErrorException
InternalErrorExceptionvoid updateItem(InputStream fileData) throws InternalErrorException, InsufficientPrivilegesException, ItemNotFoundException
fileData - InternalErrorExceptionInsufficientPrivilegesExceptionItemNotFoundExceptionCopyright © 2020. All Rights Reserved.