com.appiancorp.suiteapi.common.paging

Class TypedValueDataSubset

java.lang.Object

com.appiancorp.suiteapi.common.paging.DataSubset<TypedValue,TypedValue>

com.appiancorp.suiteapi.common.paging.TypedValueDataSubset

public class TypedValueDataSubset
extends DataSubset<TypedValue,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.

This class provides strong-typing support for TypedValue-based paging data. The class is JAXB-compatible and generates standard XML that conforms to the XSD defined by the DataSubset class. This means it can be used as the runtime return or parameter type in both custom smart services and expressions functions.

Field Summary

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

BATCH_SIZE_FIELD_NAME, IDENTIFIERS_FIELD_NAME, LOCAL_PART, QNAME, RESULTS_FIELD_NAME, SORT_FIELD_NAME, START_INDEX_FIELD_NAME, TOTAL_COUNT_FIELD_NAME, XML_ROOT_ELEMENT

Constructor Summary

Constructors

Constructor and Description
TypedValueDataSubset()
TypedValueDataSubset(int startIndex, int batchSize, java.util.List<SortInfo> sort, int totalCount, java.util.List<TypedValue> data, java.util.List<TypedValue> identifiers)
TypedValueDataSubset(PagingInfo pagingInfo, int totalCount, java.util.List<TypedValue> data, java.util.List<TypedValue> identifiers)

Method Summary

Modifier and Type	Method and Description
java.util.List<TypedValue>	getData() Returns the paged results.
java.util.List<TypedValue>	getIdentifiers() Returns the identifiers of the data in getData().
protected void	setData(java.util.List<TypedValue> data) Sets the paged results
protected void	setIdentifiers(java.util.List<TypedValue> identifiers) Sets the the identifiers of the data in getData().

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

getBatchSize, getSort, getStartIndex, getTotalCount, multilineToString, multilineToStringHelper, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedValueDataSubset

public TypedValueDataSubset()

TypedValueDataSubset

public TypedValueDataSubset(PagingInfo pagingInfo,
                            int totalCount,
                            java.util.List<TypedValue> data,
                            java.util.List<TypedValue> identifiers)

TypedValueDataSubset

public TypedValueDataSubset(int startIndex,
                            int batchSize,
                            java.util.List<SortInfo> sort,
                            int totalCount,
                            java.util.List<TypedValue> data,
                            java.util.List<TypedValue> identifiers)

Method Detail

getData

public java.util.List<TypedValue> getData()

Returns the paged results.

Specified by:

getData in class DataSubset<TypedValue,TypedValue>

getIdentifiers

public java.util.List<TypedValue> getIdentifiers()

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

Specified by:

getIdentifiers in class DataSubset<TypedValue,TypedValue>

setData

protected void setData(java.util.List<TypedValue> data)

Sets the paged results

Specified by:

setData in class DataSubset<TypedValue,TypedValue>

Parameters:

data - List of TypedValue results

setIdentifiers

protected void setIdentifiers(java.util.List<TypedValue> identifiers)

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

Specified by:

setIdentifiers in class DataSubset<TypedValue,TypedValue>

Parameters:

identifiers - List of TypedValue identifiers