com.box.boxjavalibv2.resourcemanagers

Interface IBoxFoldersManager

All Superinterfaces:

IBoxResourceManager

All Known Implementing Classes:

BoxFoldersManageImpl

public interface IBoxFoldersManager
extends IBoxResourceManager

Method Summary

Methods

Modifier and Type	Method and Description
BoxFolder	copyFolder(String folderId, BoxItemCopyRequestObject requestObject) Copy a folder.
BoxFolder	createFolder(BoxFolderRequestObject requestObject) Create a folder.
BoxFolder	createSharedLink(String folderId, BoxSharedLinkRequestObject requestObject) Create a shared link for a folder, given the id of the file/folder.
void	deleteFolder(String folderId, BoxFolderDeleteRequestObject requestObject) Delete a folder.
BoxFolder	getFolder(String folderId, BoxDefaultRequestObject requestObject) Get folder given a folder id.
List<BoxCollaboration>	getFolderCollaborations(String folderId, BoxDefaultRequestObject requestObject) Get collaborations of a folder.
BoxCollection	getFolderItems(String folderId, BoxPagingRequestObject requestObject) Get the items(subfolders, files, weblinks...) under a folder.
BoxFolder	updateFolderInfo(String folderId, BoxFolderRequestObject requestObject) Update info for a folder.

Method Detail

getFolder

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

Get 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.

createFolder

BoxFolder createFolder(BoxFolderRequestObject requestObject)
                       throws BoxRestException,
                              BoxServerException,
                              AuthFatalFailureException

Create a folder.

Parameters:

requestObject - request object

Returns:

created 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.

deleteFolder

void deleteFolder(String folderId,
                BoxFolderDeleteRequestObject requestObject)
                  throws BoxRestException,
                         BoxServerException,
                         AuthFatalFailureException

Delete a folder.

Parameters:

folderId - 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.

copyFolder

BoxFolder copyFolder(String folderId,
                   BoxItemCopyRequestObject requestObject)
                     throws BoxRestException,
                            BoxServerException,
                            AuthFatalFailureException

Copy a folder.

Parameters:

folderId - id of the folder

requestObject - request object

Returns:

copied 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.

getFolderItems

BoxCollection getFolderItems(String folderId,
                           BoxPagingRequestObject requestObject)
                             throws BoxRestException,
                                    BoxServerException,
                                    AuthFatalFailureException

Get the 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

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.

updateFolderInfo

BoxFolder updateFolderInfo(String folderId,
                         BoxFolderRequestObject requestObject)
                           throws UnsupportedEncodingException,
                                  BoxRestException,
                                  BoxServerException,
                                  AuthFatalFailureException

Update info for a folder.

Parameters:

folderId - id of the folder

requestObject - request object

Returns:

updated folder

Throws:

UnsupportedEncodingException - exception

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.

createSharedLink

BoxFolder createSharedLink(String folderId,
                         BoxSharedLinkRequestObject requestObject)
                           throws BoxRestException,
                                  BoxServerException,
                                  AuthFatalFailureException

Create a shared link for a folder, given the id of the file/folder.

Parameters:

folderId - id of the folder

requestObject - request object

Returns:

the folder, with shared link related fields filled in.

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.

getFolderCollaborations

List<BoxCollaboration> getFolderCollaborations(String folderId,
                                             BoxDefaultRequestObject requestObject)
                                               throws BoxRestException,
                                                      BoxServerException,
                                                      AuthFatalFailureException

Get collaborations of a folder.

Parameters:

folderId - id of the folder

Returns:

collaborations

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.