Package com.appiancorp.type.system

Class TypedValueListViewDataSubset

java.lang.Object

com.appiancorp.suiteapi.common.paging.DataSubset<ListViewItem,I>

com.appiancorp.type.system.ListViewDataSubset<TypedValue>

com.appiancorp.type.system.TypedValueListViewDataSubset

@GwtCompatible
public class TypedValueListViewDataSubset
extends ListViewDataSubset<TypedValue>

This class is available as a preview of functionality that will be added to the supported public API in a future release. While it is in the preview phase, it is subject to change or removal without deprecation or notice. Although notice of change is not guaranteed, we will try to let developers know of major changes through announcements in release notes.

A ListViewDataSubset where the result identifiers are TypedValue objects.

Field Summary

Fields

Modifier and Type	Field	Description
static final TypedValueListViewDataSubset	EMPTY

Fields inherited from class com.appiancorp.type.system.ListViewDataSubset

QNAME, XML_ROOT_ELEMENT

Fields inherited from class com.appiancorp.suiteapi.common.paging.DataSubset

BATCH_SIZE_FIELD_NAME, IDENTIFIERS_FIELD_NAME, RESULTS_FIELD_NAME, SORT_FIELD_NAME, START_INDEX_FIELD_NAME, TOTAL_COUNT_FIELD_NAME

Constructor Summary

Constructors

Constructor	Description
TypedValueListViewDataSubset(int startIndex, int batchSize, List<SortInfo> sort, int totalCount, List<ListViewItem> data, List<TypedValue> ids, List<AppianError> errors)	Constructs a TypedValueListViewDataSubset using the given start index, batch size, list of sort information, the total number of results, the list of results, the underlying data source identifiers, and any errors that were collected while building this DataSubset.
TypedValueListViewDataSubset(PagingInfo pagingInfo, int totalCount, List<ListViewItem> data, List<TypedValue> ids, List<AppianError> errors)	The identifiers in a TypedValueListViewDataSubset will be TypedValue objects.

Method Summary

Modifier and Type	Method	Description
List<TypedValue>	getIdentifiers()	Returns the identifiers of the data in ListViewDataSubset.getData().
protected void	setIdentifiers(List<TypedValue> identifiers)	Sets the the identifiers of the data in DataSubset.getData().

Methods inherited from class com.appiancorp.type.system.ListViewDataSubset

equalDataCheck, getData, getErrors, multilineToString, multilineToStringHelper, setData, toString

Methods inherited from class com.appiancorp.suiteapi.common.paging.DataSubset

getBatchSize, getSort, getStartIndex, getTotalCount

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final TypedValueListViewDataSubset EMPTY

Constructor Details

TypedValueListViewDataSubset

public TypedValueListViewDataSubset(PagingInfo pagingInfo,
 int totalCount,
 List<ListViewItem> data,
 List<TypedValue> ids,
 List<AppianError> errors)

The identifiers in a TypedValueListViewDataSubset will be TypedValue objects.

Parameters:

pagingInfo - the PagingInfo used to specific the start and size of the view

totalCount - the total number of results available

data - the list of results

ids - the underlying data source identifiers

errors - errors that were collected while building this DataSubset

TypedValueListViewDataSubset

public TypedValueListViewDataSubset(int startIndex,
 int batchSize,
 List<SortInfo> sort,
 int totalCount,
 List<ListViewItem> data,
 List<TypedValue> ids,
 List<AppianError> errors)

Constructs a TypedValueListViewDataSubset using the given start index, batch size, list of sort information, the total number of results, the list of results, the underlying data source identifiers, and any errors that were collected while building this DataSubset.

Parameters:

startIndex - the beginning of the view

batchSize - the request number of results

sort - a list of SortInfo

totalCount - the total number of results available

data - the list of results

ids - the underlying data source identifiers

errors - errors that were collected while building this DataSubset

Method Details

getIdentifiers

public List<TypedValue> getIdentifiers()

Returns the identifiers of the data in ListViewDataSubset.getData(). These are only unique if the underlying data source guarantees uniqueness.

Specified by:

getIdentifiers in class DataSubset<ListViewItem,TypedValue>

Returns:

the identifiers of the data in the DataSubset

setIdentifiers

protected void setIdentifiers(List<TypedValue> identifiers)

Description copied from class: DataSubset

Sets the the identifiers of the data in DataSubset.getData().

Specified by:

setIdentifiers in class DataSubset<ListViewItem,TypedValue>

Parameters:

identifiers - List of identifiers