org.jbei.ice.lib.folder

Class FolderContents

java.lang.Object

org.jbei.ice.lib.folder.FolderContents

public class FolderContents
extends Object

Contents of a folder which could be other folders or biological parts (entries)

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
FolderContents()

Method Summary

Modifier and Type	Method and Description
protected List<FolderDetails>	addEntriesToFolders(String userId, List<Long> entries, List<FolderDetails> folders) Attempts to add the specified list of entries to the specified folder destinations.
protected FolderDetails	addEntriesToTransferredFolder(List<Long> entries, Folder folder)
List<FolderDetails>	addEntrySelection(String userId, EntrySelection entryLocation) Adds entries in the selection context, to specified folders
protected List<FolderDetails>	addRemoteEntries(String userId, List<PartData> remoteEntries, List<FolderDetails> folders)
protected void	addToRemoteFolder(Account account, Folder folder, List<Long> entries)
protected List<AccessPermission>	getAndFilterFolderPermissions(String userId, Folder folder) The permission(s) enabling the share for user is(are) included.
FolderDetails	getContents(String userId, long folderId, PageParameters pageParameters) Retrieves the folder specified in the parameter and contents
protected FolderDetails	getRemoteContents(String userId, Folder folder, PageParameters pageParameters) Retrieves contents of a folder that has been shared remotely with this instance
FolderDetails	getRemotelySharedContents(String remoteUserId, String token, RegistryPartner partner, long folderId, PageParameters pageParameters)
boolean	remotelyAddEntrySelection(String remoteUserId, long folderId, String remoteUserToken, EntrySelection selection, RegistryPartner requestingPartner)
boolean	removeFolderContents(String userId, long folderId, EntrySelection selection, boolean move) Removes the specified contents of a folder, optionally adding them to another folder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FolderContents

public FolderContents()

Method Detail

remotelyAddEntrySelection

public boolean remotelyAddEntrySelection(String remoteUserId,
                                         long folderId,
                                         String remoteUserToken,
                                         EntrySelection selection,
                                         RegistryPartner requestingPartner)

addRemoteEntries

protected List<FolderDetails> addRemoteEntries(String userId,
                                               List<PartData> remoteEntries,
                                               List<FolderDetails> folders)

Parameters:

remoteEntries - list of entries that map to entries on other ICE instances. It contains enough information for the table view (as a cache)

folders - list of folders that the remote entries are to be added to

Returns:

List of folders that the specified entries were added to

addEntrySelection

public List<FolderDetails> addEntrySelection(String userId,
                                             EntrySelection entryLocation)

Adds entries in the selection context, to specified folders

Parameters:

userId - unique identifier for user making request

entryLocation - entry selection context which also contains the folders to add the entries obtained from the context to

Returns:

list of folders that the entries where added to. They should correspond to the specified folders in the selection context

addEntriesToTransferredFolder

protected FolderDetails addEntriesToTransferredFolder(List<Long> entries,
                                                      Folder folder)

removeFolderContents

public boolean removeFolderContents(String userId,
                                    long folderId,
                                    EntrySelection selection,
                                    boolean move)

Removes the specified contents of a folder, optionally adding them to another folder

Parameters:

userId - unique identifier for user making request

folderId - unique identifier for folder whose (specified) entries are being removed

selection - wrapper around the selection context for the contents

move - true, if the contents are to be added to another (set of) folder(s) (which should be specified in selection parameter)

Returns:

true, if action completed successfully; false otherwise

addEntriesToFolders

protected List<FolderDetails> addEntriesToFolders(String userId,
                                                  List<Long> entries,
                                                  List<FolderDetails> folders)

Attempts to add the specified list of entries to the specified folder destinations. The user making the request must have read privileges on the entries and write privileges on the destination folders. Any entries that the user is not permitted to read will not be be added and any destination folders that the user does not have write privileges for will not have entries added to it

Parameters:

userId - unique identifier for user making request

entries - list of entry identifiers to be added. Specified user must have read privileges on any that are to be added

folders - list of folders that that entries are to be added to

Returns:

list of destination folders that were updated successfully

addToRemoteFolder

protected void addToRemoteFolder(Account account,
                                 Folder folder,
                                 List<Long> entries)

getContents

public FolderDetails getContents(String userId,
                                 long folderId,
                                 PageParameters pageParameters)

Retrieves the folder specified in the parameter and contents

Parameters:

userId - unique identifier for user making request. If null, folder must have public read privs

folderId - unique identifier for folder to be retrieved

pageParameters - paging parameters

Returns:

wrapper around list of folder entries if folder is found, null otherwise

Throws:

PermissionException - if user does not have read permissions on folder

getRemoteContents

protected FolderDetails getRemoteContents(String userId,
                                          Folder folder,
                                          PageParameters pageParameters)

Retrieves contents of a folder that has been shared remotely with this instance

Parameters:

userId - user folder is shared with

folder - remote shared folder

Returns:

wrapper around entries conforming to specified parameters

Throws:

IllegalArgumentException - if the folder is not of type REMOTE

getRemotelySharedContents

public FolderDetails getRemotelySharedContents(String remoteUserId,
                                               String token,
                                               RegistryPartner partner,
                                               long folderId,
                                               PageParameters pageParameters)

getAndFilterFolderPermissions

protected List<AccessPermission> getAndFilterFolderPermissions(String userId,
                                                               Folder folder)

The permission(s) enabling the share for user is(are) included. If the user is an admin then all the permissions are included, otherwise only those pertaining to the user are included.

e.g. if a folder F is shared with groups A and B and the user is a non-admin belonging to group B, folder F will be included in the list of folders returned but will only include permissions for group B

Parameters:

userId - identifier for user making request

folder - Folder whose permissions are to be retrieved

Returns:

list of filtered permissions