DataSubset (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.common.paging.DataSubset<T,I>

Type Parameters:

T - The type of the results accessible in getData()

I - The type of the identifiers

Direct Known Subclasses:

ListViewDataSubset, TypedValueDataSubset
```
public abstract class DataSubset<T,I>
extends java.lang.Object
```
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 view that holds a range of data (getData()). If the results are part of larger set, getTotalCount() will be larger than the number of available results. The boundaries of the view, with respect to the larger set, can be retrieved from getStartIndex() and getBatchSize(). The results are identified by getIdentifiers(), which should be either null or of the same size as getData(). The identifiers are unique only when the underlying data source guarantees uniqueness.
To use this class in both expression functions and smart services, it's necessary to create a type that extends DataSubset and use the XmlSeeAlso annotation to specify the list of types (classes) that the result page may hold at runtime. It's not necessary to specify Java primitive wrappers or their array types nor it's necessary to list classes that can be statically reached from another type already included. The subclass must define both an XmlType and XmlRootElement annotations.
When subclasses are used as a parameter or return type in expression functions or smart services, it's recommended the Type annotation value matches the one defined by QNAME, not the one defined by the subclass, this is important if the subclass does not define extra fields since using will make the subclass appear as a generic DataSubset type to both expression functions and smart services, maximizing interoperability.
Any subclass of this should add the following Jaxb annotations:
Add @XmlElement(type=Object.class, nillable=true, namespace="") to getData() and getIdentifiers() along with an @XmlSeeAlso({T.class,I.class}) where T and I are the type parameters to this class.
Add @XmlRootElement(namespace=Type.APPIAN_NAMESPACE, name=DataSubset.XML_ROOT_ELEMENT) annotation to the class
Add @XmlType(namespace=[Your Namespace], propOrder = {"startIndex", "batchSize", "sort", "totalCount", "data", "identifiers"}) annotation to the class

 {@code

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BATCH_SIZE_FIELD_NAME`
`static java.lang.String`	`IDENTIFIERS_FIELD_NAME`
`static java.lang.String`	`LOCAL_PART`
`static javax.xml.namespace.QName`	`QNAME`
`static java.lang.String`	`RESULTS_FIELD_NAME`
`static java.lang.String`	`SORT_FIELD_NAME`
`static java.lang.String`	`START_INDEX_FIELD_NAME`
`static java.lang.String`	`TOTAL_COUNT_FIELD_NAME`
`protected static java.lang.String`	`XML_ROOT_ELEMENT` This is both the XML type name and the UUID of the system record created from this Java class

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DataSubset()`
	`DataSubset(int startIndex, int batchSize, java.util.List<SortInfo> sort, int totalCount, java.util.List<T> results, java.util.List<I> identifiers)` Creates a view that holds a range of data.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getBatchSize()` Returns the number of requested elements.
`abstract java.util.List<T>`	`getData()` Returns the paged results.
`abstract java.util.List<I>`	`getIdentifiers()` Returns the identifiers of the data in `getData()`.
`java.util.List<SortInfo>`	`getSort()` Returns the sort expressions that have been applied to the data in `getData()`.
`int`	`getStartIndex()` Returns the start index of this paged result.
`int`	`getTotalCount()` Returns the total number of results available in the data source.
`static com.appian.core.base.ToStringFunction<? extends DataSubset>`	`multilineToString(int indent)`
`protected com.appian.core.base.MultilineToStringHelper`	`multilineToStringHelper(int indent)`
`protected abstract void`	`setData(java.util.List<T> data)` Sets the results
`protected abstract void`	`setIdentifiers(java.util.List<I> identifiers)` Sets the the identifiers of the data in `getData()`.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - START_INDEX_FIELD_NAME
```
public static final java.lang.String START_INDEX_FIELD_NAME
```
    See Also:
    
    Constant Field Values
  - BATCH_SIZE_FIELD_NAME
```
public static final java.lang.String BATCH_SIZE_FIELD_NAME
```
    See Also:
    
    Constant Field Values
  - SORT_FIELD_NAME
```
public static final java.lang.String SORT_FIELD_NAME
```
    See Also:
    
    Constant Field Values
  - TOTAL_COUNT_FIELD_NAME
```
public static final java.lang.String TOTAL_COUNT_FIELD_NAME
```
    See Also:
    
    Constant Field Values
  - RESULTS_FIELD_NAME
```
public static final java.lang.String RESULTS_FIELD_NAME
```
    See Also:
    
    Constant Field Values
  - IDENTIFIERS_FIELD_NAME
```
public static final java.lang.String IDENTIFIERS_FIELD_NAME
```
    See Also:
    
    Constant Field Values
  - XML_ROOT_ELEMENT
```
protected static final java.lang.String XML_ROOT_ELEMENT
```
    This is both the XML type name and the UUID of the system record created from this Java class
    
    See Also:
    
    Constant Field Values
  - LOCAL_PART
```
public static final java.lang.String LOCAL_PART
```
    See Also:
    
    Constant Field Values
  - QNAME
```
public static final javax.xml.namespace.QName QNAME
```
- Constructor Detail
  - DataSubset
```
protected DataSubset()
```
  - DataSubset
```
public DataSubset(int startIndex,
                  int batchSize,
                  java.util.List<SortInfo> sort,
                  int totalCount,
                  java.util.List<T> results,
                  java.util.List<I> identifiers)
```
    Creates a view that holds a range of data. identifiers must be either null or the same size as results.
    
    Parameters:
    
    results - the view of the data.
    
    identifiers - underlying data source identifiers. Unique only when the data source guarantees uniqueness
    
    startIndex - the beginning of the view
    
    batchSize - the "requested" number of results. The actual number of results may be less if the end of the underlying data is reached. A negative batchSize indicates that the maximum number of returned results was not limited.
    
    totalCount - total number of results available in the data source
    
    sort -
- Method Detail
  - getStartIndex
```
public int getStartIndex()
```
    Returns the start index of this paged result.
  - getBatchSize
```
public int getBatchSize()
```
    Returns the number of requested elements. The actual number of results in this paged result can be retrieved from getData(). A negative batchSize indicates that the maximum number of returned results should not be limited.
  - getTotalCount
```
public int getTotalCount()
```
    Returns the total number of results available in the data source.
  - getData
```
public abstract java.util.List<T> getData()
```
    Returns the paged results.
  - getIdentifiers
```
public abstract java.util.List<I> getIdentifiers()
```
    Returns the identifiers of the data in getData(). These are only unique if the underlying data source guarantees uniqueness.
  - setData
```
protected abstract void setData(java.util.List<T> data)
```
    Sets the results
    
    Parameters:
    
    data - List of results
  - setIdentifiers
```
protected abstract void setIdentifiers(java.util.List<I> identifiers)
```
    Sets the the identifiers of the data in getData().
    
    Parameters:
    
    identifiers - List of identifiers
  - getSort
```
public java.util.List<SortInfo> getSort()
```
    Returns the sort expressions that have been applied to the data in getData().
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - multilineToStringHelper
```
protected com.appian.core.base.MultilineToStringHelper multilineToStringHelper(int indent)
```
  - multilineToString
```
public static com.appian.core.base.ToStringFunction<? extends DataSubset> multilineToString(int indent)
```

Class DataSubset<T,I>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

START_INDEX_FIELD_NAME

BATCH_SIZE_FIELD_NAME

SORT_FIELD_NAME

TOTAL_COUNT_FIELD_NAME

RESULTS_FIELD_NAME

IDENTIFIERS_FIELD_NAME

XML_ROOT_ELEMENT

LOCAL_PART

QNAME

Constructor Detail

DataSubset

DataSubset

Method Detail

getStartIndex

getBatchSize

getTotalCount

getData

getIdentifiers

setData

setIdentifiers

getSort

toString

multilineToStringHelper

multilineToString