org.jbei.ice.lib.entry

Class EntryHistory

java.lang.Object

org.jbei.ice.lib.entry.EntryHistory

public class EntryHistory
extends Object

History information for a specified entry

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
EntryHistory(String userId, long entryId)

Method Summary

Modifier and Type	Method and Description
boolean	add() Adds a read history object for the specified user and entry
boolean	delete(long historyId)
int	deleteAll() Delete all available history for a specified entry Due to the destructive nature, it is required that the user be the owner or an administrator
Results<History>	get(int limit, int offset, boolean asc, String sort)

Methods inherited from class java.lang.Object

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

Constructor Detail

EntryHistory

public EntryHistory(String userId,
                    long entryId)

Parameters:

userId - unique identifier for user making requests

entryId - unique identifier for entry whose history is of interest

Throws:

IllegalArgumentException - if the entry specified by id entryId is not located

Method Detail

get

public Results<History> get(int limit,
                            int offset,
                            boolean asc,
                            String sort)

delete

public boolean delete(long historyId)

add

public boolean add()

Adds a read history object for the specified user and entry

Returns:

true if the object was successfully added, false otherwise

deleteAll

public int deleteAll()

Delete all available history for a specified entry Due to the destructive nature, it is required that the user be the owner or an administrator

Returns:

the number of audit objects that were deleted

Throws:

PermissionException - if the user performing action is neither an admin nor owner of the entry