com.box.androidsdk.content.requests

Class BoxRequestsFolder.GetFolderWithAllItems

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItem<BoxFolder,BoxRequestsFolder.GetFolderWithAllItems>

com.box.androidsdk.content.requests.BoxRequestsFolder.GetFolderWithAllItems

All Implemented Interfaces:

BoxCacheableRequest<BoxFolder>, java.io.Serializable

Enclosing class:

BoxRequestsFolder

public static class BoxRequestsFolder.GetFolderWithAllItems
extends BoxRequestItem<BoxFolder,BoxRequestsFolder.GetFolderWithAllItems>
implements BoxCacheableRequest<BoxFolder>

Get full folder including all information of all children

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

Modifier and Type	Field and Description
static int	DEFAULT_MAX_LIMIT

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

Constructor and Description
GetFolderWithAllItems(java.lang.String folderId, java.lang.String infoUrl, java.lang.String itemsUrl, BoxSession session)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIfNoneMatchEtag()
BoxFolder	onSend() Synchronously make the request to Box and handle the response appropriately.
protected void	onSendCompleted(BoxResponse<BoxFolder> response) Post action that will be performed after a successful send occurs.
BoxFolder	sendForCachedResult() Sends the request to fetch results from cache synchronously.
BoxRequestsFolder.GetFolderWithAllItems	setIfNoneMatchEtag(java.lang.String etag)
BoxRequestsFolder.GetFolderWithAllItems	setMaximumLimit(int maxLimit)
BoxFutureTask<BoxFolder>	toTaskForCachedResult() Converts the request to a BoxCacheFutureTask that can be used to execute the request asynchronously.

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

addRepresentationHintGroup, createHeaderMap, getId, setFields

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

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_LIMIT

public static int DEFAULT_MAX_LIMIT

Constructor Detail

GetFolderWithAllItems

public GetFolderWithAllItems(java.lang.String folderId,
                             java.lang.String infoUrl,
                             java.lang.String itemsUrl,
                             BoxSession session)

Method Detail

onSend

public BoxFolder onSend()
                 throws BoxException

Description copied from class: BoxRequest

Synchronously make the request to Box and handle the response appropriately.

Overrides:

onSend in class BoxRequest<BoxFolder,BoxRequestsFolder.GetFolderWithAllItems>

Returns:

the expected BoxObject if the request is successful.

Throws:

BoxException - thrown if there was a problem with handling the request.

setMaximumLimit

public BoxRequestsFolder.GetFolderWithAllItems setMaximumLimit(int maxLimit)

setIfNoneMatchEtag

public BoxRequestsFolder.GetFolderWithAllItems setIfNoneMatchEtag(java.lang.String etag)

Overrides:

setIfNoneMatchEtag in class BoxRequest<BoxFolder,BoxRequestsFolder.GetFolderWithAllItems>

getIfNoneMatchEtag

public java.lang.String getIfNoneMatchEtag()

Overrides:

getIfNoneMatchEtag in class BoxRequest<BoxFolder,BoxRequestsFolder.GetFolderWithAllItems>

sendForCachedResult

public BoxFolder sendForCachedResult()
                              throws BoxException

Description copied from interface: BoxCacheableRequest

Sends the request to fetch results from cache synchronously.

Specified by:

sendForCachedResult in interface BoxCacheableRequest<BoxFolder>

Returns:

the cached results of the request

Throws:

BoxException - thrown if there is no implementation of BoxCache set in BoxConfig, or if there was another issue getting cached results.

toTaskForCachedResult

public BoxFutureTask<BoxFolder> toTaskForCachedResult()
                                               throws BoxException

Description copied from interface: BoxCacheableRequest

Converts the request to a BoxCacheFutureTask that can be used to execute the request asynchronously.

Specified by:

toTaskForCachedResult in interface BoxCacheableRequest<BoxFolder>

Returns:

a task that will fetch the results from the cache

Throws:

BoxException - thrown if there is no implementation of BoxCache set in BoxConfig.

onSendCompleted

protected void onSendCompleted(BoxResponse<BoxFolder> response)
                        throws BoxException

Description copied from class: BoxRequest

Post action that will be performed after a successful send occurs. Example useage would include updating the cache after a request is made

Overrides:

onSendCompleted in class BoxRequestItem<BoxFolder,BoxRequestsFolder.GetFolderWithAllItems>

Parameters:

response - response of the BoxRequest

Throws:

BoxException - thrown if there was a problem with handling the request.