BulkUploadController (ice 5.3.1 API)

java.lang.Object
- org.jbei.ice.lib.bulkupload.BulkUploadController

```
public class BulkUploadController
extends Object
```
Controller for dealing with bulk imports (including drafts)

Author:

Hector Plahar

Constructor Summary

Constructors
Constructor and Description

BulkUploadController()

Constructors
Constructor and Description
`BulkUploadController()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttachmentInfo`	`addAttachment(String userId, long bulkUploadId, long entryId, InputStream fileInputStream, String fileName)`
`AccessPermission`	`addPermission(String userId, long uploadId, AccessPermission access)` Adds specified access permission to the bulk upload.
`SequenceInfo`	`addSequence(String userId, long bulkUploadId, long entryId, String sequenceString, String fileName)`
`boolean`	`approveBulkImport(String userId, long id)`
`BulkUploadAutoUpdate`	`autoUpdateBulkUpload(String userId, BulkUploadAutoUpdate autoUpdate, EntryType addType)`
`protected void`	`clearBulkEdits(String userId)` Removes any bulk edits belonging to the specified user
`BulkUploadInfo`	`create(String userId, BulkUploadInfo info)` Creates a new bulk upload.
`boolean`	`deleteAttachment(String userId, long bulkUploadId, long entryId)`
`BulkUploadInfo`	`deleteDraftById(String userId, long draftId)` Deletes a bulk import draft referenced by a unique identifier.
`boolean`	`deleteEntry(String userId, long uploadId, long entryId)`
`boolean`	`deletePermission(String userId, long uploadId, long permissionId)` Removes specified permission from bulk upload
`BulkUploadInfo`	`getBulkImport(String userId, long id, int offset, int limit)` Retrieves bulk import and entries associated with it that are referenced by the id in the parameter.
`ArrayList<String>`	`getMatchingPartNumbersForLinks(EntryType type, String token, int limit)` Retrieves part numbers that match the token passed in the parameter, that are compatible with the type in the parameter.
`HashMap<String,ArrayList<BulkUploadInfo>>`	`getPendingImports(String userId)` Retrieves list of bulk imports that are owned by the system.
`ArrayList<BulkUploadInfo>`	`getPendingUploads(String userId)`
`List<AccessPermission>`	`getUploadPermissions(String userId, long uploadId)`
`ArrayList<BulkUploadInfo>`	`retrieveByUser(String requesterId, String userAccountId)` Retrieves list of user saved bulk imports.
`boolean`	`revertSubmitted(Account account, long uploadId)`
`protected PartData`	`setFileData(String userId, Entry entry, PartData partData)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BulkUploadController
```
public BulkUploadController()
```
- Method Detail
  - create
```
public BulkUploadInfo create(String userId,
                             BulkUploadInfo info)
```
    Creates a new bulk upload. If upload type is not bulk edit, then the status is set to in progress. Default permissions consisting of read permissions for the public groups that the requesting user is a part of are added
    
    Parameters:
    
    userId - identifier for user making request
    
    info - bulk upload data
    
    Returns:
    
    created upload
  - clearBulkEdits
```
protected void clearBulkEdits(String userId)
```
    Removes any bulk edits belonging to the specified user
    
    Parameters:
    
    userId - unique identifier for user whose bulk edits are to be removed
  - getPendingImports
```
public HashMap<String,ArrayList<BulkUploadInfo>> getPendingImports(String userId)
```
    Retrieves list of bulk imports that are owned by the system. System ownership is assigned to all bulk imports that are submitted by non-admins and indicates that it is pending approval.
    Administrative privileges are required for making this call
    
    Parameters:
    
    userId - account for user making request; expected to be an administrator
    
    Returns:
    
    list of bulk imports pending verification
  - getBulkImport
```
public BulkUploadInfo getBulkImport(String userId,
                                    long id,
                                    int offset,
                                    int limit)
```
    Retrieves bulk import and entries associated with it that are referenced by the id in the parameter. Only owners or administrators are allowed to retrieve bulk imports
    
    Parameters:
    
    userId - identifier for account of user requesting
    
    id - unique identifier for bulk import
    
    offset - offset for upload entries (start)
    
    limit - maximum number of entries to return with the upload
    
    Returns:
    
    data transfer object with the retrieved bulk import data and associated entries
    
    Throws:
    
    PermissionException
  - setFileData
```
protected PartData setFileData(String userId,
                               Entry entry,
                               PartData partData)
```
  - retrieveByUser
```
public ArrayList<BulkUploadInfo> retrieveByUser(String requesterId,
                                                String userAccountId)
```
    Retrieves list of user saved bulk imports. Only the owner or an administrator can retrieve it
    
    Parameters:
    
    requesterId - account of requesting user
    
    userAccountId - account identifier for user whose saved drafts are being requested
    
    Returns:
    
    list of draft infos representing saved drafts.
  - getPendingUploads
```
public ArrayList<BulkUploadInfo> getPendingUploads(String userId)
```
  - deleteDraftById
```
public BulkUploadInfo deleteDraftById(String userId,
                                      long draftId)
                               throws PermissionException
```
    Deletes a bulk import draft referenced by a unique identifier. only owners of the bulk import or administrators are permitted to delete bulk imports
    
    Parameters:
    
    userId - account of user making the request
    
    draftId - unique identifier for bulk import
    
    Returns:
    
    deleted bulk import
    
    Throws:
    
    PermissionException
  - autoUpdateBulkUpload
```
public BulkUploadAutoUpdate autoUpdateBulkUpload(String userId,
                                                 BulkUploadAutoUpdate autoUpdate,
                                                 EntryType addType)
```
  - revertSubmitted
```
public boolean revertSubmitted(Account account,
                               long uploadId)
```
  - approveBulkImport
```
public boolean approveBulkImport(String userId,
                                 long id)
```
  - addSequence
```
public SequenceInfo addSequence(String userId,
                                long bulkUploadId,
                                long entryId,
                                String sequenceString,
                                String fileName)
```
  - addAttachment
```
public AttachmentInfo addAttachment(String userId,
                                    long bulkUploadId,
                                    long entryId,
                                    InputStream fileInputStream,
                                    String fileName)
```
  - deleteAttachment
```
public boolean deleteAttachment(String userId,
                                long bulkUploadId,
                                long entryId)
```
  - deleteEntry
```
public boolean deleteEntry(String userId,
                           long uploadId,
                           long entryId)
```
  - getUploadPermissions
```
public List<AccessPermission> getUploadPermissions(String userId,
                                                   long uploadId)
```
  - addPermission
```
public AccessPermission addPermission(String userId,
                                      long uploadId,
                                      AccessPermission access)
```
    Adds specified access permission to the bulk upload.
    
    Parameters:
    
    userId - unique identifier of user making the request. Must be an admin or owner of the upload
    
    uploadId - unique identifier for bulk upload
    
    access - details about the permission to the added
    
    Returns:
    
    added permission with identifier that can be used to remove/delete the permission
    
    Throws:
    
    IllegalArgumentException - if the upload cannot be located using its identifier
  - deletePermission
```
public boolean deletePermission(String userId,
                                long uploadId,
                                long permissionId)
```
    Removes specified permission from bulk upload
    
    Parameters:
    
    userId - unique identifier of user making the request. Must be an admin or owner of the bulk upload
    
    uploadId - unique identifier for bulk upload
    
    permissionId - unique identifier for permission that has been previously added to upload
    
    Returns:
    
    true if deletion is successful
    
    Throws:
    
    IllegalArgumentException - if upload or permission cannot be located by their identifiers
  - getMatchingPartNumbersForLinks
```
public ArrayList<String> getMatchingPartNumbersForLinks(EntryType type,
                                                        String token,
                                                        int limit)
```
    Retrieves part numbers that match the token passed in the parameter, that are compatible with the type in the parameter. Two entry types are compatible if they can be associated with specific entries (as descendants) in a hierarchical relationship
    
    Parameters:
    
    type - type of entry the part numbers must be compatible with
    
    token - part number token to match
    
    limit - maximum number of matches to return
    
    Returns:
    
    list of part numbers that can be linked to the type of entry

Class BulkUploadController

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BulkUploadController

Method Detail

create

clearBulkEdits

getPendingImports

getBulkImport

setFileData

retrieveByUser

getPendingUploads

deleteDraftById

autoUpdateBulkUpload

revertSubmitted

approveBulkImport

addSequence

addAttachment

deleteAttachment

deleteEntry

getUploadPermissions

addPermission

deletePermission

getMatchingPartNumbersForLinks