I
- identifiers@GwtCompatible public abstract class ListViewDataSubset<I> extends DataSubset<ListViewItem,I>
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 is a DataSubset
designed specifically to be used with ListView
objects. The items in the data
field of a ListViewDataSubset are of type ListViewItem
.
@XmlElement(type=Object.class, nillable=true, namespace="")
DataSubset.getIdentifiers()
along with an @XmlSeeAlso(I.class)
where
I is the type parameter to this class.
@XmlRootElement(namespace=Type.APPIAN_NAMESPACE, name=ListViewDataSubset.XML_ROOT_ELEMENT)
annotation
to the class @XmlType(namespace=[Your Namespace], propOrder = {"startIndex", "batchSize", "sort", "totalCount", "data", "identifiers", "errors"})
annotation to the class
DataSubset
Modifier and Type | Field and Description |
---|---|
static javax.xml.namespace.QName |
QNAME |
protected static java.lang.String |
XML_ROOT_ELEMENT |
BATCH_SIZE_FIELD_NAME, IDENTIFIERS_FIELD_NAME, RESULTS_FIELD_NAME, SORT_FIELD_NAME, START_INDEX_FIELD_NAME, TOTAL_COUNT_FIELD_NAME
Modifier | Constructor and Description |
---|---|
protected |
ListViewDataSubset() |
|
ListViewDataSubset(int startIndex,
int batchSize,
java.util.List<SortInfo> sort,
int totalCount,
java.util.List<ListViewItem> data,
java.util.List<I> ids,
java.util.List<AppianError> errors)
Same as other constructor except the paging information is broken out into separate parameters
|
|
ListViewDataSubset(PagingInfo pagingInfo,
int totalCount,
java.util.List<ListViewItem> data,
java.util.List<I> ids,
java.util.List<AppianError> errors)
Constructs a ListViewDataSubset using the given paging information, the total number of results, the list
of results, the underlying data source identifiers, and the list of errors collected while building this
datasubset.
|
Modifier and Type | Method and Description |
---|---|
static com.google.common.base.Equivalence<ListViewDataSubset<?>> |
equalDataCheck()
Returns an Equivalence object that can be used to determine if two ListViewDataSubset objects are equal.
|
java.util.List<ListViewItem> |
getData()
Returns the paged results.
|
java.util.List<AppianError> |
getErrors()
Returns the list of errors generated while building this ListViewDataSubset
|
static com.appian.core.base.ToStringFunction<ListViewDataSubset> |
multilineToString(int indent)
Returns a
ToStringFunction that can be used to generate the multiline String representation
of a ListViewDataSubset |
protected com.appian.core.base.MultilineToStringHelper |
multilineToStringHelper(int indent) |
protected void |
setData(java.util.List<ListViewItem> data)
Sets the results
|
java.lang.String |
toString() |
getBatchSize, getIdentifiers, getSort, getStartIndex, getTotalCount, setIdentifiers
protected static final java.lang.String XML_ROOT_ELEMENT
public static final javax.xml.namespace.QName QNAME
protected ListViewDataSubset()
public ListViewDataSubset(PagingInfo pagingInfo, int totalCount, java.util.List<ListViewItem> data, java.util.List<I> ids, java.util.List<AppianError> errors)
ListViewItem
objects.pagingInfo
- the paging constraints and sorting info applied to this resulttotalCount
- the total number of items available as the result, which may be greater than the
number of items returned in this data subsetdata
- the list of itemsids
- a parallel list of identifiers for the itemserrors
- a parallel list of errors that should be returned instead of the corresponding item,
place a null in the corresponding list position to indicate no error; leave entire list null if there
are no errorspublic ListViewDataSubset(int startIndex, int batchSize, java.util.List<SortInfo> sort, int totalCount, java.util.List<ListViewItem> data, java.util.List<I> ids, java.util.List<AppianError> errors)
public java.util.List<AppianError> getErrors()
public java.util.List<ListViewItem> getData()
getData
in class DataSubset<ListViewItem,I>
protected void setData(java.util.List<ListViewItem> data)
DataSubset
setData
in class DataSubset<ListViewItem,I>
data
- List of resultspublic java.lang.String toString()
toString
in class DataSubset<ListViewItem,I>
protected com.appian.core.base.MultilineToStringHelper multilineToStringHelper(int indent)
multilineToStringHelper
in class DataSubset<ListViewItem,I>
public static com.appian.core.base.ToStringFunction<ListViewDataSubset> multilineToString(int indent)
ToStringFunction
that can be used to generate the multiline String representation
of a ListViewDataSubsetindent
- - number of spaces to increment each level of indentationpublic static com.google.common.base.Equivalence<ListViewDataSubset<?>> equalDataCheck()
Copyright © 2003-2023 Appian Corporation. All Rights Reserved.