com.hellosign.sdk.resource

Class AbstractResourceList<E>

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.AbstractResourceList<E>

All Implemented Interfaces:

Iterable<E>

Direct Known Subclasses:

ApiAppList, SignatureRequestList, TemplateList

public abstract class AbstractResourceList<E>
extends AbstractResource
implements Iterable<E>

Field Summary

Fields

Modifier and Type	Field and Description
static String	LIST_INFO
static String	NUM_PAGES
static String	NUM_RESULTS
static String	PAGE
static String	PAGE_SIZE

Fields inherited from class com.hellosign.sdk.resource.AbstractResource

dataObj, warnings

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractResourceList(org.json.JSONObject json, String listKey)

Method Summary

Methods

Modifier and Type	Method and Description
List<E>	filterCurrentPageBy(String columnName, Serializable filterValue) Filters the current page of results by the given column and value.
List<E>	getCurrentPageList() Returns the current page of results for this list object.
Integer	getNumPages()
Integer	getNumResults()
Integer	getPage()
Integer	getPageSize()
Iterator<E>	iterator()

Methods inherited from class com.hellosign.sdk.resource.AbstractResource

add, addToList, clearList, get, getBoolean, getConstructor, getDate, getInteger, getJSONObject, getList, getList, getLong, getString, getWarnings, has, hasString, set, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LIST_INFO

public static final String LIST_INFO

See Also:

Constant Field Values

PAGE

public static final String PAGE

See Also:

Constant Field Values

NUM_PAGES

public static final String NUM_PAGES

See Also:

Constant Field Values

NUM_RESULTS

public static final String NUM_RESULTS

See Also:

Constant Field Values

PAGE_SIZE

public static final String PAGE_SIZE

See Also:

Constant Field Values

Constructor Detail

AbstractResourceList

protected AbstractResourceList(org.json.JSONObject json,
                    String listKey)
                        throws HelloSignException

Throws:

HelloSignException

Method Detail

getPage

public Integer getPage()

getNumPages

public Integer getNumPages()

getNumResults

public Integer getNumResults()

getPageSize

public Integer getPageSize()

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

getCurrentPageList

public List<E> getCurrentPageList()
                           throws HelloSignException

Returns the current page of results for this list object.

Returns:

List

Throws:

HelloSignException - thrown if the list cannot be generated

filterCurrentPageBy

public List<E> filterCurrentPageBy(String columnName,
                          Serializable filterValue)
                            throws HelloSignException

Filters the current page of results by the given column and value.

Parameters:

columnName - String column name to filter by

filterValue - Serializable matching value

Returns:

List results

Throws:

HelloSignException - thrown if the column name is invalid