org.jbei.ice.lib.folder.collection

Class CollectionEntries

java.lang.Object

org.jbei.ice.lib.folder.collection.CollectionEntries

public class CollectionEntries
extends Object

Represents entries contained within a specified collection filtered by the permissions available to the person retrieving the entries

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
CollectionEntries(String userId, CollectionType type)

Method Summary

Modifier and Type	Method and Description
protected Results<PartData>	getAvailableEntries(ColumnField field, boolean asc, int offset, int limit, String filter) Retrieves entries available to user.
Results<PartData>	getEntries(ColumnField field, boolean asc, int offset, int limit) Retrieves list of entries without filter text getEntries which this delegates to with null filter value
Results<PartData>	getEntries(ColumnField field, boolean asc, int offset, int limit, String filter) Retrieves parts (paged and sorted by the specified parameter values) based on the type of collection.
protected Results<PartData>	getEntriesByVisibility(Visibility visibility, ColumnField field, boolean asc, int offset, int limit, String user, String filter) Retrieves entries by the specified visibility.
protected Results<PartData>	getPersonalEntries(ColumnField field, boolean asc, int offset, int limit, String filter) Retrieves entries owned by user
protected Results<PartData>	getSharedEntries(ColumnField field, boolean asc, int offset, int limit, String filter) Retrieves entries shared with user.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionEntries

public CollectionEntries(String userId,
                         CollectionType type)

Method Detail

getEntries

public Results<PartData> getEntries(ColumnField field,
                                    boolean asc,
                                    int offset,
                                    int limit)

Retrieves list of entries without filter text getEntries which this delegates to with null filter value

Parameters:

field - sort field

asc - sort order

offset - paging start

limit - maximum number of entries to retrieve

Returns:

wrapper around list of parts that conform to the parameters and the maximum number of such entries that are available

getEntries

public Results<PartData> getEntries(ColumnField field,
                                    boolean asc,
                                    int offset,
                                    int limit,
                                    String filter)

Retrieves parts (paged and sorted by the specified parameter values) based on the type of collection.

Parameters:

field - sort field

asc - sort order

offset - paging start

limit - maximum number of entries to retrieve

filter - optional text

Returns:

wrapper around list of parts that conform to the parameters and the maximum number of such entries that are available

getPersonalEntries

protected Results<PartData> getPersonalEntries(ColumnField field,
                                               boolean asc,
                                               int offset,
                                               int limit,
                                               String filter)

Retrieves entries owned by user

Parameters:

field - sort field

asc - sort order

offset - paging start

limit - maximum number of entries to retrieve

filter - optional text to filter entries by

Returns:

wrapper around list of parts that conform to the parameters and the maximum number of such entries that are available

Throws:

PermissionException - on null user id which is required for owner entries

getAvailableEntries

protected Results<PartData> getAvailableEntries(ColumnField field,
                                                boolean asc,
                                                int offset,
                                                int limit,
                                                String filter)

Retrieves entries available to user. "Availability" is determined by any permissions set on the entries

Parameters:

field - sort field

asc - sort order

offset - paging start

limit - maximum number of entries to retrieve

filter - optional text to filter entries by

Returns:

wrapper around list of parts that conform to the parameters and the maximum number of such entries that are available

getSharedEntries

protected Results<PartData> getSharedEntries(ColumnField field,
                                             boolean asc,
                                             int offset,
                                             int limit,
                                             String filter)

Retrieves entries shared with user.

Parameters:

field - sort field

asc - sort order ascending if true, descending if false

offset - paging parameter start

limit - maximum number of entries to retrieve

filter - optional text to filter entries by

Returns:

wrapper around list of parts matching the parameters along with the maximum number of entries available

getEntriesByVisibility

protected Results<PartData> getEntriesByVisibility(Visibility visibility,
                                                   ColumnField field,
                                                   boolean asc,
                                                   int offset,
                                                   int limit,
                                                   String user,
                                                   String filter)

Retrieves entries by the specified visibility. Visibility is used to create collections of entries

Parameters:

visibility - visibility to retrieve entries by

field - sort field

asc - sort order

offset - paging start

limit - maximum number of entries to retrieve

user - additional user filter

filter - optional text to filter entries by

Returns:

wrapper around list of parts that conform to the parameters and the maximum number of such entries that are available