com.box.androidsdk.content.requests

Class BoxRequestsUser.GetEnterpriseUsers

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItem<BoxIteratorUsers,BoxRequestsUser.GetEnterpriseUsers>

com.box.androidsdk.content.requests.BoxRequestsUser.GetEnterpriseUsers

All Implemented Interfaces:

BoxCacheableRequest<BoxIteratorUsers>, java.io.Serializable

Enclosing class:

BoxRequestsUser

public static class BoxRequestsUser.GetEnterpriseUsers
extends BoxRequestItem<BoxIteratorUsers,BoxRequestsUser.GetEnterpriseUsers>
implements BoxCacheableRequest<BoxIteratorUsers>

Request to get users that belong to the admins enterprise

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
protected static java.lang.String	QUERY_FILTER_TERM
protected static java.lang.String	QUERY_LIMIT
protected static java.lang.String	QUERY_OFFSET

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
GetEnterpriseUsers(java.lang.String requestUrl, BoxSession session) Creates a get enterprise users request with the default parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFilterTerm() Gets the string used to filter the results to only users starting with the filter term in either the name or the login
long	getLimit() Gets the number of records to return.
long	getOffset() Gets the record at which to start
BoxIteratorUsers	sendForCachedResult() Sends the request to fetch results from cache synchronously.
BoxRequestsUser.GetEnterpriseUsers	setFilterTerm(java.lang.String filterTerm) Sets the string used to filter the results to only users starting with the filter term in either the name or the login
BoxRequestsUser.GetEnterpriseUsers	setLimit(long limit) Sets the number of records to return.
BoxRequestsUser.GetEnterpriseUsers	setOffset(long offset) Sets the record at which to start
BoxFutureTask<BoxIteratorUsers>	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, onSendCompleted, setFields

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

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

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_FILTER_TERM

protected static final java.lang.String QUERY_FILTER_TERM

See Also:

Constant Field Values

QUERY_LIMIT

protected static final java.lang.String QUERY_LIMIT

See Also:

Constant Field Values

QUERY_OFFSET

protected static final java.lang.String QUERY_OFFSET

See Also:

Constant Field Values

Constructor Detail

GetEnterpriseUsers

public GetEnterpriseUsers(java.lang.String requestUrl,
                          BoxSession session)

Creates a get enterprise users request with the default parameters

Parameters:

requestUrl - URL of the enterprise users endpoint

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

Method Detail

getFilterTerm

public java.lang.String getFilterTerm()

Gets the string used to filter the results to only users starting with the filter term in either the name or the login

Returns:

string used to filter the results to only users starting with the filter term in either the name or the login

setFilterTerm

public BoxRequestsUser.GetEnterpriseUsers setFilterTerm(java.lang.String filterTerm)

Sets the string used to filter the results to only users starting with the filter term in either the name or the login

Parameters:

filterTerm - the string used to filter the results

Returns:

The get enterprise users request

getLimit

public long getLimit()

Gets the number of records to return.

Returns:

the number of records to return.

setLimit

public BoxRequestsUser.GetEnterpriseUsers setLimit(long limit)

Sets the number of records to return.

Parameters:

limit - the number of records to return.

Returns:

The get enterprise users request

getOffset

public long getOffset()

Gets the record at which to start

Returns:

the record at which to start

setOffset

public BoxRequestsUser.GetEnterpriseUsers setOffset(long offset)

Sets the record at which to start

Parameters:

offset - the record at which to start

Returns:

The get enterprise users request

sendForCachedResult

public BoxIteratorUsers sendForCachedResult()
                                     throws BoxException

Description copied from interface: BoxCacheableRequest

Sends the request to fetch results from cache synchronously.

Specified by:

sendForCachedResult in interface BoxCacheableRequest<BoxIteratorUsers>

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<BoxIteratorUsers> 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<BoxIteratorUsers>

Returns:

a task that will fetch the results from the cache

Throws:

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