com.box.boxjavalibv2.resourcemanagers

Interface IBoxItemsManager

All Superinterfaces:

IBoxResourceManager

All Known Implementing Classes:

BoxFilesManagerImpl, BoxFoldersManageImpl, BoxItemsManagerImpl, BoxSearchManagerImpl

public interface IBoxItemsManager
extends IBoxResourceManager

Method Summary

Methods

Modifier and Type	Method and Description
BoxItem	copyItem(String id, BoxItemCopyRequestObject requestObject, BoxResourceType type) Copy an item.
BoxItem	createSharedLink(String id, BoxSharedLinkRequestObject requestObject, BoxResourceType type) Create a shared link for an item, given the id .
BoxItem	getItem(String id, BoxDefaultRequestObject requestObject, BoxResourceType type) Get item given an item id.
BoxItem	updateItemInfo(String id, BoxItemRequestObject requestObject, BoxResourceType type) Update info for an item

Method Detail

getItem

BoxItem getItem(String id,
              BoxDefaultRequestObject requestObject,
              BoxResourceType type)
                throws BoxRestException,
                       BoxServerException,
                       AuthFatalFailureException

Get item given an item id.

Parameters:

id - id of the item

requestObject - requestObject

type - resource type

Returns:

requested box file/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.

copyItem

BoxItem copyItem(String id,
               BoxItemCopyRequestObject requestObject,
               BoxResourceType type)
                 throws BoxRestException,
                        BoxServerException,
                        AuthFatalFailureException

Copy an item.

Parameters:

id - id of the item

requestObject - request object

type - resource type of the item

Returns:

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

updateItemInfo

BoxItem updateItemInfo(String id,
                     BoxItemRequestObject requestObject,
                     BoxResourceType type)
                       throws UnsupportedEncodingException,
                              BoxRestException,
                              BoxServerException,
                              AuthFatalFailureException

Update info for an item

Parameters:

id - id of the item

requestObject - request object

type - resource type of the item

Returns:

updated file/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

BoxItem createSharedLink(String id,
                       BoxSharedLinkRequestObject requestObject,
                       BoxResourceType type)
                         throws BoxRestException,
                                BoxServerException,
                                AuthFatalFailureException

Create a shared link for an item, given the id .

Parameters:

id - id of the item

requestObject - request object

type - resource type of this item

Returns:

the file/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.