org.jbei.ice.lib.entry

Class EntryController

java.lang.Object

org.jbei.ice.lib.entry.HasEntry

org.jbei.ice.lib.entry.EntryController

public class EntryController
extends HasEntry

ABI to manipulate Entrys.

Author:

Timothy Ham, Zinovii Dmytriv, Hector Plahar, Elena Aravina

Field Summary

Fields inherited from class org.jbei.ice.lib.entry.HasEntry

accountDAO, entryDAO

Constructor Summary

Constructors

Constructor and Description
EntryController()

Method Summary

Modifier and Type	Method and Description
protected boolean	canEdit(String userId, String depositor, Entry entry)
UserComment	createEntryComment(String userId, long partId, UserComment newComment)
boolean	deleteShotgunSequence(String userId, long entryId, long shotgunId)
boolean	deleteTraceSequence(String userId, long entryId, long traceId)
PartData	getRequestedEntry(String remoteUserId, String token, String entryId, long folderId, RegistryPartner requestingPartner)
boolean	moveEntriesToTrash(String userId, ArrayList<PartData> list) Moves the specified list of entries to the deleted folder.
ArrayList<UserComment>	retrieveEntryComments(String userId, long partId)
protected PartData	retrieveEntryDetails(String userId, Entry entry)
PartData	retrieveEntryDetails(String userId, String id)
PartStatistics	retrieveEntryStatistics(String userId, long entryId)
PartData	retrieveEntryTipDetails(String id)
void	update(String userId, Entry entry)
UserComment	updateEntryComment(String userId, long partId, long commentId, UserComment userComment)
long	updatePart(String userId, long partId, PartData part) Update the information associated with the specified part. Note that any missing information will be deleted from the original entry.

Methods inherited from class org.jbei.ice.lib.entry.HasEntry

getEntry

Methods inherited from class java.lang.Object

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

Constructor Detail

EntryController

public EntryController()

Method Detail

updatePart

public long updatePart(String userId,
                       long partId,
                       PartData part)

Update the information associated with the specified part.
Note that any missing information will be deleted from the original entry. In other words, if the part referenced by id partId has an alias value of alias and the part object passed in the parameter does not contain this value, when this method returns, the original entry's alias field will be removed.

Parameters:

userId - unique identifier for user making request

partId - unique identifier for part being updated. This overrides the id in the partData object

part - information to update part with

Returns:

unique identifier for part that was updated

Throws:

IllegalArgumentException - if the entry associated with the partId cannot be located

update

public void update(String userId,
                   Entry entry)

retrieveEntryTipDetails

public PartData retrieveEntryTipDetails(String id)

retrieveEntryComments

public ArrayList<UserComment> retrieveEntryComments(String userId,
                                                    long partId)

createEntryComment

public UserComment createEntryComment(String userId,
                                      long partId,
                                      UserComment newComment)

updateEntryComment

public UserComment updateEntryComment(String userId,
                                      long partId,
                                      long commentId,
                                      UserComment userComment)

deleteTraceSequence

public boolean deleteTraceSequence(String userId,
                                   long entryId,
                                   long traceId)

deleteShotgunSequence

public boolean deleteShotgunSequence(String userId,
                                     long entryId,
                                     long shotgunId)

canEdit

protected boolean canEdit(String userId,
                          String depositor,
                          Entry entry)

retrieveEntryStatistics

public PartStatistics retrieveEntryStatistics(String userId,
                                              long entryId)

moveEntriesToTrash

public boolean moveEntriesToTrash(String userId,
                                  ArrayList<PartData> list)

Moves the specified list of entries to the deleted folder. If an already deleted entry (list of entries) is being deleted then the status "permanently deleted" is assigned, and these entries become invisible to everyone.

Parameters:

userId - unique identifier for user making the request. Must have write access privileges on the entries in the list

list - unique identifiers for entries

Returns:

true or false if operation succeeds on all listed entries or not

getRequestedEntry

public PartData getRequestedEntry(String remoteUserId,
                                  String token,
                                  String entryId,
                                  long folderId,
                                  RegistryPartner requestingPartner)

retrieveEntryDetails

public PartData retrieveEntryDetails(String userId,
                                     String id)

retrieveEntryDetails

protected PartData retrieveEntryDetails(String userId,
                                        Entry entry)
                                 throws PermissionException

Throws:

PermissionException