com.box.androidsdk.content.requests

Class BoxRequestItemUpdate<E extends BoxItem,R extends BoxRequest<E,R>>

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<E,R>

com.box.androidsdk.content.requests.BoxRequestItem<E,R>

com.box.androidsdk.content.requests.BoxRequestItemUpdate<E,R>

Type Parameters:

E - type of BoxItem that is being updated.

R - type of BoxRequest that is being created.

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxRequestsBookmark.UpdateBookmark, BoxRequestsFile.UpdateFile, BoxRequestsFolder.UpdateFolder, BoxRequestUpdateSharedItem

public abstract class BoxRequestItemUpdate<E extends BoxItem,R extends BoxRequest<E,R>>
extends BoxRequestItem<E,R>

Abstract class that represents an item update request.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.content.requests.BoxRequest

BoxRequest.BoxRequestHandler<R extends BoxRequest>, BoxRequest.ContentTypes, BoxRequest.Methods, BoxRequest.TLSSSLSocketFactory

Field Summary

Fields inherited from class com.box.androidsdk.content.requests.BoxRequestItem

mHintHeader, mId, QUERY_FIELDS

Fields inherited from class com.box.androidsdk.content.requests.BoxRequest

JSON_OBJECT, mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mRequiresSocket, mSession, mTimeout

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BoxRequestItemUpdate(BoxRequestItemUpdate r)
	BoxRequestItemUpdate(java.lang.Class<E> clazz, java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates an update item request with the default parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Returns the new description currently set for the item.
java.lang.String	getIfMatchEtag() Returns the etag currently set in the if-match header.
java.lang.String	getName() Returns the new name currently set for the item.
java.lang.String	getParentId() Returns the new parent id currently set for the item.
BoxSharedLink	getSharedLink() Returns the shared link currently set for the item.
java.util.List<java.lang.String>	getTags() Returns the tags currently set for the item.
protected void	parseHashMapEntry(com.eclipsesource.json.JsonObject jsonBody, java.util.Map.Entry<java.lang.String,java.lang.Object> entry)
R	setDescription(java.lang.String description) Sets the new description for the item.
R	setIfMatchEtag(java.lang.String etag) Sets the if-match header for the request.
R	setName(java.lang.String name) Sets the new name for the item.
R	setParentId(java.lang.String parentId) Sets the new parent id for the item.
R	setSharedLink(BoxSharedLink sharedLink) Sets the new shared link for the item.
R	setTags(java.util.List<java.lang.String> tags) Sets the new tags for the item.
abstract BoxRequestUpdateSharedItem	updateSharedLink() Converts the BoxRequestItemUpdate into a BoxRequestUpdateSharedItem.

Methods inherited from class com.box.androidsdk.content.requests.BoxRequestItem

addRepresentationHintGroup, createHeaderMap, getId, onSendCompleted, setFields

Methods inherited from class com.box.androidsdk.content.requests.BoxRequest

buildUrl, createHttpRequest, createQuery, equals, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logDebug, logRequest, onSend, parseJsonObject, send, sendRequest, setBody, setContentType, setHeaders, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BoxRequestItemUpdate

public BoxRequestItemUpdate(java.lang.Class<E> clazz,
                            java.lang.String id,
                            java.lang.String requestUrl,
                            BoxSession session)

Creates an update item request with the default parameters.

Parameters:

clazz - class of the item to return in the response.

id - id of the item being updated.

requestUrl - URL for the update item endpoint.

session - authenticated session that will be used to make the request with.

BoxRequestItemUpdate

protected BoxRequestItemUpdate(BoxRequestItemUpdate r)

Method Detail

updateSharedLink

public abstract BoxRequestUpdateSharedItem updateSharedLink()

Converts the BoxRequestItemUpdate into a BoxRequestUpdateSharedItem. Using the request you can update shared link of the item.

Returns:

BoxRequestUpdateSharedItem from the BoxRequestItemUpdate.

getName

public java.lang.String getName()

Returns the new name currently set for the item.

Returns:

name for the item, or null if not set.

setName

public R setName(java.lang.String name)

Sets the new name for the item.

Parameters:

name - new name for the item.

Returns:

request with the updated name.

getDescription

public java.lang.String getDescription()

Returns the new description currently set for the item.

Returns:

description for the item, or null if not set.

setDescription

public R setDescription(java.lang.String description)

Sets the new description for the item.

Parameters:

description - description for the item.

Returns:

request with the updated description.

getParentId

public java.lang.String getParentId()

Returns the new parent id currently set for the item.

Returns:

id of the parent folder for the item, or null if not set.

setParentId

public R setParentId(java.lang.String parentId)

Sets the new parent id for the item.

Parameters:

parentId - id of the new parent folder for the item.

Returns:

request with the updated parent id.

getSharedLink

public BoxSharedLink getSharedLink()

Returns the shared link currently set for the item.

Returns:

shared link for the item, or null if not set.

setSharedLink

public R setSharedLink(BoxSharedLink sharedLink)

Sets the new shared link for the item.

Parameters:

sharedLink - new shared link for the item.

Returns:

request with the updated shared link.

setIfMatchEtag

public R setIfMatchEtag(java.lang.String etag)

Sets the if-match header for the request. The item will only be updated if the specified etag matches the most current etag for the item.

Overrides:

setIfMatchEtag in class BoxRequest<E extends BoxItem,R extends BoxRequest<E,R>>

Parameters:

etag - etag to set in the if-match header.

Returns:

request with the updated if-match header.

getIfMatchEtag

public java.lang.String getIfMatchEtag()

Returns the etag currently set in the if-match header.

Overrides:

getIfMatchEtag in class BoxRequest<E extends BoxItem,R extends BoxRequest<E,R>>

Returns:

etag set in the if-match header, or null if none set.

getTags

public java.util.List<java.lang.String> getTags()

Returns the tags currently set for the item.

Returns:

tags for the item, or null if not set.

setTags

public R setTags(java.util.List<java.lang.String> tags)

Sets the new tags for the item.

Parameters:

tags - new tags for the item.

Returns:

request with the updated tags.

parseHashMapEntry

protected void parseHashMapEntry(com.eclipsesource.json.JsonObject jsonBody,
                                 java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

Overrides:

parseHashMapEntry in class BoxRequest<E extends BoxItem,R extends BoxRequest<E,R>>