Package com.testdroid.api
Class APIList<T extends APIEntity>
- java.lang.Object
-
- com.testdroid.api.APIEntity
-
- com.testdroid.api.APIList<T>
-
-
Field Summary
-
Fields inherited from class com.testdroid.api.APIEntity
client, id, OBJECT_MAPPER, parentId, selfURI, XML_MAPPER
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected <S extends APIEntity>
voidclone(S from)
static java.lang.String
filterParam(java.util.List<FilterEntry> filters)
T
get(int index)
Context<T>
getContext()
java.util.List<T>
getData()
Get found data of the list.java.lang.Integer
getLimit()
Get limit of data page returned ingetData()
method.java.lang.String
getNext()
Get full URL of the next page of the collection.APIList<T>
getNextItems()
java.lang.Integer
getOffset()
Get offset of data page returned ingetData()
method.java.lang.String
getPrevious()
Get full URL of the previous page of the collection.APIList<T>
getPreviousItems()
java.lang.String
getSearch()
Get search phrase used during retrieving data returned ingetData()
method.java.lang.String
getSort()
Get serialized sort value used during retrieving data returned ingetData()
method.java.lang.Integer
getTotal()
Get total number of items to be returned - independent from paging.boolean
isEmpty()
void
refresh()
void
setContext(Context<T> context)
void
setData(java.util.List<T> data)
void
setLimit(java.lang.Integer limit)
void
setNext(java.lang.String next)
void
setOffset(java.lang.Integer offset)
void
setPrevious(java.lang.String previous)
void
setSearch(java.lang.String search)
void
setSort(java.lang.String sort)
void
setTotal(java.lang.Integer total)
-
Methods inherited from class com.testdroid.api.APIEntity
cloneBase, createUri, deleteResource, getFile, getId, getListResource, getListResource, getParentId, getResource, getSelfURI, postFile, postResource, setId, setSelfURI, toJson
-
-
-
-
Method Detail
-
getNext
public java.lang.String getNext()
Get full URL of the next page of the collection. Simple call it to fetch next items.
-
setNext
public void setNext(java.lang.String next)
-
getNextItems
public APIList<T> getNextItems() throws APIException
- Throws:
APIException
-
getPreviousItems
public APIList<T> getPreviousItems() throws APIException
- Throws:
APIException
-
getPrevious
public java.lang.String getPrevious()
Get full URL of the previous page of the collection. Simple call it to fetch previous items.
-
setPrevious
public void setPrevious(java.lang.String previous)
-
getData
public java.util.List<T> getData()
Get found data of the list. List contains only set of items contrained withoffset
,limit
andsearch
.
-
setData
public void setData(java.util.List<T> data)
-
get
public T get(int index)
-
isEmpty
public boolean isEmpty()
-
getOffset
public java.lang.Integer getOffset()
Get offset of data page returned ingetData()
method.
-
setOffset
public void setOffset(java.lang.Integer offset)
-
getLimit
public java.lang.Integer getLimit()
Get limit of data page returned ingetData()
method.
-
setLimit
public void setLimit(java.lang.Integer limit)
-
getTotal
public java.lang.Integer getTotal()
Get total number of items to be returned - independent from paging.
-
setTotal
public void setTotal(java.lang.Integer total)
-
getSearch
public java.lang.String getSearch()
Get search phrase used during retrieving data returned ingetData()
method.
-
setSearch
public void setSearch(java.lang.String search)
-
getSort
public java.lang.String getSort()
Get serialized sort value used during retrieving data returned ingetData()
method.
-
setSort
public void setSort(java.lang.String sort)
-
refresh
public void refresh() throws APIException
- Overrides:
refresh
in classAPIEntity
- Throws:
APIException
-
filterParam
public static java.lang.String filterParam(java.util.List<FilterEntry> filters)
-
-