org.jbei.ice.services.rest

Class CollectionResource

java.lang.Object

org.jbei.ice.services.rest.RestResource

org.jbei.ice.services.rest.CollectionResource

@Path(value="/collections")
public class CollectionResource
extends RestResource

Collections represent system defined sets of parts. These are:

• Available
• Personal
• Shared
• Drafts
• Deleted
• Transferred

These cannot be created or deleted by users

Author:

Hector Plahar

Field Summary

Fields inherited from class org.jbei.ice.services.rest.RestResource

API_KEY_CLIENT_ID, API_KEY_TOKEN, API_KEY_USER, apiClientId, apiToken, apiUser, AUTHENTICATION_PARAM_NAME, hmacHeader, querySessionId, REMOTE_USER_ID, REMOTE_USER_TOKEN, remoteUserId, remoteUserToken, request, sessionId, WOR_PARTNER_TOKEN, worPartnerToken

Constructor Summary

Constructors

Constructor and Description
CollectionResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getCollectionFolder(CollectionType type, long folderId) Retrieves the specified collection type's folder Since the folder is intended to be retrieved from a specified resource's context, this may not always return a result even the folder with the specified id exists
javax.ws.rs.core.Response	getCollectionStats() Retrieve the statistics (counts) of all the collections for the specified user
javax.ws.rs.core.Response	getCollectionSubFolders(CollectionType type)
javax.ws.rs.core.Response	read(String collectionType, int offset, int limit, String sort, boolean asc, String filter, List<String> queryParam) Retrieve entries by collection type using paging parameters, including a filter

Methods inherited from class org.jbei.ice.services.rest.RestResource

addHeaders, getThisServer, getUserId, getUserId, getWebPartner, log, requireUserId, requireUserIdOrWebPartner, requireWebPartner, respond, respond, respond, respond

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionResource

public CollectionResource()

Method Detail

getCollectionStats

@GET
 @Path(value="/counts")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getCollectionStats()

Retrieve the statistics (counts) of all the collections for the specified user

getCollectionSubFolders

@GET
 @Path(value="/{type}/folders")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getCollectionSubFolders(@DefaultValue(value="PERSONAL") @PathParam(value="type")
                                                                                                                                   CollectionType type)

Returns:

all folders found under a collection of specified type

getCollectionFolder

@GET
 @Path(value="/{type}/folders/{id}")
public javax.ws.rs.core.Response getCollectionFolder(@PathParam(value="type")
                                                                                               CollectionType type,
                                                                                               @PathParam(value="id")
                                                                                               long folderId)

Retrieves the specified collection type's folder Since the folder is intended to be retrieved from a specified resource's context, this may not always return a result even the folder with the specified id exists

read

@GET
 @Produces(value="application/json")
 @Path(value="/{type}/entries")
public javax.ws.rs.core.Response read(@PathParam(value="type")
                                                                                                                String collectionType,
                                                                                                                @DefaultValue(value="0") @QueryParam(value="offset")
                                                                                                                int offset,
                                                                                                                @DefaultValue(value="15") @QueryParam(value="limit")
                                                                                                                int limit,
                                                                                                                @DefaultValue(value="created") @QueryParam(value="sort")
                                                                                                                String sort,
                                                                                                                @DefaultValue(value="false") @QueryParam(value="asc")
                                                                                                                boolean asc,
                                                                                                                @DefaultValue(value="") @QueryParam(value="filter")
                                                                                                                String filter,
                                                                                                                @QueryParam(value="fields")
                                                                                                                List<String> queryParam)

Retrieve entries by collection type using paging parameters, including a filter