org.jbei.ice.lib.folder

Class FolderController

java.lang.Object

org.jbei.ice.lib.folder.FolderController

public class FolderController
extends Object

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
FolderController()

Method Summary

Modifier and Type	Method and Description
FolderDetails	createPersonalFolder(String userId, FolderDetails folderDetails)
FolderDetails	createTransferredFolder(FolderDetails folderDetails)
FolderDetails	delete(String userId, long folderId, FolderType type) Deletes either a user folder or bulk upload (which is represented as a folder to the user)
protected FolderDetails	demoteFolder(String userId, Folder folder) Opposite of FolderController#demoteFolder(userId, long) Removes the folder from being a featured collections
protected Account	getAccount(String userId)
ArrayList<FolderDetails>	getAvailableFolders(String userId) Retrieves folders that have been "promoted" by an administrator to imply that they are to be made available to everyone on the site
ArrayList<FolderDetails>	getBulkUploadDrafts(String userId)
ArrayList<FolderDetails>	getPendingBulkUploads(String userId) Retrieves information about submitted bulk uploads that have status "PENDING".
FolderDetails	getPublicEntries(ColumnField sort, int offset, int limit, boolean asc) Retrieves entries that are made available publicly
ArrayList<FolderDetails>	getPublicFolders() Retrieves folders that are shared shared publicly.
ArrayList<FolderDetails>	getSharedUserFolders(String userId) Retrieves folders that have been shared with specified user as an individual or as part of a group.
ArrayList<FolderDetails>	getTransferredFolders(String userId)
ArrayList<FolderDetails>	getUserFolders(String userId)
protected FolderDetails	promoteFolder(String userId, Folder folder) "Promote"s a collection into a featured collection.
FolderDetails	update(String userId, long folderId, FolderDetails details) Updates the folder referenced by the folderId with the passed folder details.

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderController

public FolderController()

Method Detail

getAvailableFolders

public ArrayList<FolderDetails> getAvailableFolders(String userId)

Retrieves folders that have been "promoted" by an administrator to imply that they are to be made available to everyone on the site

Parameters:

userId - unique user identifier

Returns:

list of folders that are contained under the "Available" section

getPublicFolders

public ArrayList<FolderDetails> getPublicFolders()

Retrieves folders that are shared shared publicly. Note that this is different from featured folders that have a type of PUBLIC

Returns:

list of public folders on this site

getPublicEntries

public FolderDetails getPublicEntries(ColumnField sort,
                                      int offset,
                                      int limit,
                                      boolean asc)

Retrieves entries that are made available publicly

Parameters:

sort - order of retrieval for the entries

offset - start of retrieval

limit - maximum number of entries to retrieve

asc - whether to retrieve the entries in ascending order

Returns:

wrapper around the retrieved entries

getBulkUploadDrafts

public ArrayList<FolderDetails> getBulkUploadDrafts(String userId)

getPendingBulkUploads

public ArrayList<FolderDetails> getPendingBulkUploads(String userId)

Retrieves information about submitted bulk uploads that have status "PENDING". Administrator only function

Parameters:

userId - unique identifier for user performing action. Must have admin privileges

Returns:

list of information about pending bulk uploads is user has administrative privileges, null otherwise

update

public FolderDetails update(String userId,
                            long folderId,
                            FolderDetails details)

Updates the folder referenced by the folderId with the passed folder details. If the propagate parameter is set (differs from existing folder's value) then the contained entries are updated accordingly.

Parameters:

userId - unique identifier for user making request. Must have write privileges

folderId - unique identifier for folder being updated

details - new details to update

Returns:

updated folder's details

Throws:

PermissionException - if user making request doesn't have the appropriate privileges

delete

public FolderDetails delete(String userId,
                            long folderId,
                            FolderType type)

Deletes either a user folder or bulk upload (which is represented as a folder to the user)

Parameters:

userId - unique identifier for user requesting delete action

folderId - unique identifier for folder to be deleted

type - type of folder to be deleted (either "UPLOAD" or "PRIVATE")

Returns:

delete folder details

createPersonalFolder

public FolderDetails createPersonalFolder(String userId,
                                          FolderDetails folderDetails)

createTransferredFolder

public FolderDetails createTransferredFolder(FolderDetails folderDetails)

getUserFolders

public ArrayList<FolderDetails> getUserFolders(String userId)

getSharedUserFolders

public ArrayList<FolderDetails> getSharedUserFolders(String userId)

Retrieves folders that have been shared with specified user as an individual or as part of a group.

Parameters:

userId - User whose shared folders are being retrieved

Returns:

list of folders meeting the shared criteria

getTransferredFolders

public ArrayList<FolderDetails> getTransferredFolders(String userId)

getAccount

protected Account getAccount(String userId)

promoteFolder

protected FolderDetails promoteFolder(String userId,
                                      Folder folder)

"Promote"s a collection into a featured collection. This action is restricted to administrators. The owner does not have to be an administrator and maintains ownership after being featured

Parameters:

userId - requesting account id

folder - folder to be promoted

Returns:

true if promotion is successful, false otherwise

demoteFolder

protected FolderDetails demoteFolder(String userId,
                                     Folder folder)

Opposite of FolderController#demoteFolder(userId, long) Removes the folder from being a featured collections

Parameters:

userId - requesting account

folder - to be demoted

Returns:

true on successful remote, false otherwise