com.box.boxjavalibv2.resourcemanagers

Class BoxCollectionsManagerImpl

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxCollectionsManagerImpl

All Implemented Interfaces:

IBoxCollectionsManager, IBoxResourceManager

public final class BoxCollectionsManagerImpl
extends AbstractBoxResourceManager
implements IBoxCollectionsManager

Use this class to execute requests synchronously against the Box REST API(V2), collections endpints. Full details about the Box API can be found at http://developers.box.com/docs . You must have an OpenBox application with a valid API key to use the Box API. All methods in this class are executed in the invoking thread, and therefore are NOT safe to execute in the UI thread of your application. You should only use this class if you already have worker threads or AsyncTasks that you want to incorporate the Box API into.

Constructor Summary

Constructors

Constructor and Description
BoxCollectionsManagerImpl(IBoxConfig config, IBoxResourceHub resourceHub, IBoxJSONParser parser, IBoxRequestAuth auth, IBoxRESTClient restClient) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
BoxCollection	getAllCollections(BoxPagingRequestObject requestObject) Get all collections.
BoxItemCollection	getCollection(java.lang.String collectionId, BoxDefaultRequestObject requestObject) Get a collection.
BoxCollection	getCollectionItems(java.lang.String collectionId, BoxPagingRequestObject requestObject) Get all items in a given collection.

Methods inherited from class com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

executeRequestWithNoResponseBody, getAuth, getClassFromType, getConfig, getJSONParser, getResourceHub, getResponseAndParse, getResponseAndParseAndTryCast, getRestClient, tryCastBoxItem, tryCastObject

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxCollectionsManagerImpl

public BoxCollectionsManagerImpl(IBoxConfig config,
                         IBoxResourceHub resourceHub,
                         IBoxJSONParser parser,
                         IBoxRequestAuth auth,
                         IBoxRESTClient restClient)

Constructor.

Parameters:

config - Config

resourceHub - IResourceHub

parser - json parser

auth - auth for api calls

restClient - REST client to make api calls.

Method Detail

getCollection

public BoxItemCollection getCollection(java.lang.String collectionId,
                              BoxDefaultRequestObject requestObject)
                                throws BoxRestException,
                                       BoxServerException,
                                       AuthFatalFailureException

Description copied from interface: IBoxCollectionsManager

Get a collection.

Specified by:

getCollection in interface IBoxCollectionsManager

Parameters:

collectionId - id of the collection

requestObject - object that goes into request.

Returns:

collection (Errors may occur if the IDs are invalid or if the user does not have permissions to see the collection.)

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See BoxServerException for more info.

AuthFatalFailureException - See AuthFatalFailureException for more info.

getAllCollections

public BoxCollection getAllCollections(BoxPagingRequestObject requestObject)
                                throws BoxRestException,
                                       BoxServerException,
                                       AuthFatalFailureException

Description copied from interface: IBoxCollectionsManager

Get all collections.

Specified by:

getAllCollections in interface IBoxCollectionsManager

Parameters:

requestObject - object that goes into request.

Returns:

collections

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See BoxServerException for more info.

AuthFatalFailureException - See AuthFatalFailureException for more info.

getCollectionItems

public BoxCollection getCollectionItems(java.lang.String collectionId,
                               BoxPagingRequestObject requestObject)
                                 throws BoxRestException,
                                        BoxServerException,
                                        AuthFatalFailureException

Description copied from interface: IBoxCollectionsManager

Get all items in a given collection.

Specified by:

getCollectionItems in interface IBoxCollectionsManager

Parameters:

collectionId - id of the collection

requestObject - object that goes into request.

Returns:

collection (Errors may occur if the IDs are invalid or if the user does not have permissions to see the collection.)

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See BoxServerException for more info.

AuthFatalFailureException - See AuthFatalFailureException for more info.