com.box.boxjavalibv2.resourcemanagers

Interface IBoxTrashManager

All Superinterfaces:

IBoxResourceManager

All Known Implementing Classes:

BoxTrashManagerImpl

public interface IBoxTrashManager
extends IBoxResourceManager

Method Summary

Methods

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

Method Detail

getTrashFile

BoxFile getTrashFile(String fileId,
                   BoxDefaultRequestObject requestObject)
                     throws BoxRestException,
                            AuthFatalFailureException,
                            BoxServerException

Get trashed file given a file id.

Parameters:

fileId - id of the file

requestObject - object that goes into request.

Returns:

requested box file

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.

deleteTrashFile

void deleteTrashFile(String id,
                   BoxDefaultRequestObject requestObject)
                     throws BoxRestException,
                            BoxServerException,
                            AuthFatalFailureException

Permanently delete a trashed file.

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

BoxFile restoreTrashFile(String id,
                       BoxItemRestoreRequestObject requestObject)
                         throws BoxRestException,
                                AuthFatalFailureException,
                                BoxServerException

Restore a trashed file.

Parameters:

id - id of the trashed file.

requestObject -

Returns:

the file

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.

getTrashFolder

BoxFolder getTrashFolder(String folderId,
                       BoxDefaultRequestObject requestObject)
                         throws BoxRestException,
                                BoxServerException,
                                AuthFatalFailureException

Get trash folder given a folder id.

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.

getTrashItems

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

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

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

void deleteTrashFolder(String id,
                     BoxDefaultRequestObject requestObject)
                       throws BoxRestException,
                              BoxServerException,
                              AuthFatalFailureException

Permanently delete a trashed folder.

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

BoxFolder restoreTrashFolder(String id,
                           BoxItemRestoreRequestObject requestObject)
                             throws BoxRestException,
                                    AuthFatalFailureException,
                                    BoxServerException

Restore a trashed folder.

Parameters:

id - id of the trashed folder.

requestObject -

Returns:

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.