com.box.boxjavalibv2.resourcemanagers

Class BoxTrashManagerImpl

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxTrashManagerImpl

All Implemented Interfaces:

IBoxResourceManager, IBoxTrashManager

public class BoxTrashManagerImpl
extends AbstractBoxResourceManager
implements IBoxTrashManager

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteTrashFile(java.lang.String id, BoxDefaultRequestObject requestObject) Permanently delete a trashed file.
void	deleteTrashFolder(java.lang.String id, BoxDefaultRequestObject requestObject) Permanently delete a trashed folder.
BoxCollection	getFolderTrashItems(java.lang.String folderId, BoxPagingRequestObject requestObject) Get the trashed items(subfolders, files, weblinks...) under a folder.
BoxFile	getTrashFile(java.lang.String fileId, BoxDefaultRequestObject requestObject) Get trashed file given a file id.
BoxFolder	getTrashFolder(java.lang.String folderId, BoxDefaultRequestObject requestObject) Get trash folder given a folder id.
BoxFile	restoreTrashFile(java.lang.String id, BoxItemRestoreRequestObject requestObject) Restore a trashed file.
BoxFolder	restoreTrashFolder(java.lang.String id, BoxItemRestoreRequestObject requestObject) Restore a trashed folder.

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

BoxTrashManagerImpl

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

Method Detail

deleteTrashFile

public void deleteTrashFile(java.lang.String id,
                   BoxDefaultRequestObject requestObject)
                     throws BoxRestException,
                            BoxServerException,
                            AuthFatalFailureException

Description copied from interface: IBoxTrashManager

Permanently delete a trashed file.

Specified by:

deleteTrashFile in interface IBoxTrashManager

Parameters:

id - id of the file

requestObject - request object

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

restoreTrashFile

public BoxFile restoreTrashFile(java.lang.String id,
                       BoxItemRestoreRequestObject requestObject)
                         throws BoxRestException,
                                AuthFatalFailureException,
                                BoxServerException

Description copied from interface: IBoxTrashManager

Restore a trashed file.

Specified by:

restoreTrashFile in interface IBoxTrashManager

Parameters:

id - id of the trashed file.

Returns:

the file

Throws:

BoxRestException - See BoxRestException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

getTrashFile

public BoxFile getTrashFile(java.lang.String fileId,
                   BoxDefaultRequestObject requestObject)
                     throws BoxRestException,
                            AuthFatalFailureException,
                            BoxServerException

Description copied from interface: IBoxTrashManager

Get trashed file given a file id.

Specified by:

getTrashFile in interface IBoxTrashManager

Parameters:

fileId - id of the file

requestObject - object that goes into request.

Returns:

requested box file

Throws:

BoxRestException - See BoxRestException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

getTrashFolder

public BoxFolder getTrashFolder(java.lang.String folderId,
                       BoxDefaultRequestObject requestObject)
                         throws BoxRestException,
                                BoxServerException,
                                AuthFatalFailureException

Description copied from interface: IBoxTrashManager

Get trash folder given a folder id.

Specified by:

getTrashFolder in interface IBoxTrashManager

Parameters:

folderId - id of the folder

requestObject - object that goes into request.

Returns:

requested box folder

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

getFolderTrashItems

public BoxCollection getFolderTrashItems(java.lang.String folderId,
                                BoxPagingRequestObject requestObject)
                                  throws BoxRestException,
                                         BoxServerException,
                                         AuthFatalFailureException

Description copied from interface: IBoxTrashManager

Get the trashed items(subfolders, files, weblinks...) under a folder. By default, returning maximum of GetFolderItemsRequest#DEFAULT_FOLDER_ITEMS_LIMIT items, at an offset of GetFolderItemsRequest#DEFAULT_FOLDER_ITEMS_OFFSET

Specified by:

getFolderTrashItems in interface IBoxTrashManager

Parameters:

folderId - id of the folder.

requestObject - request object

Returns:

Items(subfolders, files, weblinks...) under the folder.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

deleteTrashFolder

public void deleteTrashFolder(java.lang.String id,
                     BoxDefaultRequestObject requestObject)
                       throws BoxRestException,
                              BoxServerException,
                              AuthFatalFailureException

Description copied from interface: IBoxTrashManager

Permanently delete a trashed folder.

Specified by:

deleteTrashFolder in interface IBoxTrashManager

Parameters:

id - id of the folder

requestObject - request object

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

restoreTrashFolder

public BoxFolder restoreTrashFolder(java.lang.String id,
                           BoxItemRestoreRequestObject requestObject)
                             throws BoxRestException,
                                    AuthFatalFailureException,
                                    BoxServerException

Description copied from interface: IBoxTrashManager

Restore a trashed folder.

Specified by:

restoreTrashFolder in interface IBoxTrashManager

Parameters:

id - id of the trashed folder.

Returns:

the folder

Throws:

BoxRestException - See BoxRestException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.