org.gcube.common.homelibrary.home.workspace

Interface WorkspaceSharedFolder

All Superinterfaces:

WorkspaceFolder, WorkspaceItem

All Known Subinterfaces:

WorkspaceVREFolder

public interface WorkspaceSharedFolder
extends WorkspaceFolder

Author:

gioia

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addAdmin(String username) Add administrators to a shared folder
void	addUser(String user)
void	deleteACL(List<String> users) Delete privileges for a list of users
List<String>	getAdministrators() Get Administrators
String	getDisplayName() Get displayName
List<String>	getGroups() Deprecated.
List<String>	getMembers() Get members: users and groups of a shared folder
String	getName(String user) Get the name
ACLType	getPrivilege() Get the privilege set on a WorkspaceSharedFolder
List<String>	getUsers()
WorkspaceCatalogue	getVRECatalogue() Get VRE Cataloge
boolean	isVreFolder() Check if the current folder is a vre folder
boolean	setAdmins(List<String> logins) Set administrators
void	setVREFolder(boolean isVREFolder) Set a folder as VRE folder
WorkspaceFolder	unShare()
WorkspaceFolder	unShare(String user) Unshare a single user

Methods inherited from interface org.gcube.common.homelibrary.home.workspace.WorkspaceFolder

createExternalFileItem, createExternalFileItem, createExternalFileItem, createExternalGenericItem, createExternalGenericItem, createExternalGenericItem, createExternalGenericItem, createExternalGenericItem, createExternalGenericItem, createExternalGenericItem, createExternalImageItem, createExternalImageItem, createExternalPDFFileItem, createExternalPDFFileItem, createExternalUrlItem, createExternalUrlItem, createExternalUrlItem, createFolder, createQueryItem, createQueryItem, createReportItem, createReportTemplateItem, createTimeSeries, exists, find, getAllChildren, getAllChildren, getChildren, getChildren, getChildren, getChildrenCount, getCount, getHiddenChildren, getLastItems, getNewFolderBulkCreator, getSize, getUniqueName, isPublic, isSystemFolder, setACL, setPublic, setSystemFolder, share

Methods inherited from interface org.gcube.common.homelibrary.home.workspace.WorkspaceItem

cloneItem, 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, updateItem

Method Detail

getDisplayName

String getDisplayName()
                      throws InternalErrorException

Get displayName

Returns:

diplay name

Throws:

InternalErrorException

getAdministrators

List<String> getAdministrators()
                               throws InternalErrorException

Get Administrators

Returns:

Administrators

Throws:

InternalErrorException

addAdmin

boolean addAdmin(String username)
                 throws InsufficientPrivilegesException,
                        InternalErrorException

Add administrators to a shared folder

Throws:

InsufficientPrivilegesException

InternalErrorException

setAdmins

boolean setAdmins(List<String> logins)
                  throws InsufficientPrivilegesException,
                         InternalErrorException

Set administrators

Throws:

InsufficientPrivilegesException

InternalErrorException

getUsers

List<String> getUsers()
                      throws InternalErrorException

Returns:

the list of users.

Throws:

InternalErrorException

addUser

void addUser(String user)
             throws InsufficientPrivilegesException,
                    InternalErrorException

Parameters:

user -

Throws:

InsufficientPrivilegesException

InternalErrorException

unShare

WorkspaceFolder unShare()
                        throws InternalErrorException

Returns:

a new WorkspaceFolder

Throws:

InternalErrorException

unShare

WorkspaceFolder unShare(String user)
                        throws InternalErrorException

Unshare a single user

Parameters:

user -

Returns:

a new WorkspaceFolder

Throws:

InternalErrorException

getName

String getName(String user)
               throws InternalErrorException

Get the name

Parameters:

user -

Returns:

the shared folder name set by the user, null if the user doen't exist.

Throws:

InternalErrorException

isVreFolder

boolean isVreFolder()

Check if the current folder is a vre folder

Returns:

true if the shared folder is a VRE folder

setVREFolder

void setVREFolder(boolean isVREFolder)
                  throws InternalErrorException

Set a folder as VRE folder

Parameters:

isVREFolder -

Throws:

InternalErrorException

getPrivilege

ACLType getPrivilege()
                     throws InternalErrorException

Get the privilege set on a WorkspaceSharedFolder

Returns:

Throws:

InternalErrorException

deleteACL

void deleteACL(List<String> users)
               throws InternalErrorException

Delete privileges for a list of users

Specified by:

deleteACL in interface WorkspaceItem

Parameters:

users -

Throws:

InternalErrorException

getMembers

List<String> getMembers()
                        throws InternalErrorException

Get members: users and groups of a shared folder

Returns:

Throws:

InternalErrorException

getGroups

@Deprecated
List<String> getGroups()
                       throws InternalErrorException

Deprecated.

Get groups in a shared folder

Returns:

Throws:

InternalErrorException

getVRECatalogue

WorkspaceCatalogue getVRECatalogue()
                                   throws InternalErrorException

Get VRE Cataloge

Returns:

VRE Cataloge

Throws:

InternalErrorException