com.box.boxjavalibv2.resourcemanagers

Interface IBoxCollectionsManager

All Superinterfaces:

IBoxResourceManager

All Known Implementing Classes:

BoxCollectionsManagerImpl

public interface IBoxCollectionsManager
extends IBoxResourceManager

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.

Method Detail

getCollection

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

Get a collection.

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

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

Get all collections.

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

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

Get all items in a given collection.

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.