Class TypedValueDataSubset
java.lang.Object
com.appiancorp.suiteapi.common.paging.DataSubset<TypedValue,TypedValue>
com.appiancorp.suiteapi.common.paging.TypedValueDataSubset
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
ConstructorDescriptionTypedValueDataSubset
(int startIndex, int batchSize, List<SortInfo> sort, int totalCount, List<TypedValue> data, List<TypedValue> identifiers) TypedValueDataSubset
(PagingInfo pagingInfo, int totalCount, List<TypedValue> data, List<TypedValue> identifiers) -
Method Summary
Modifier and TypeMethodDescriptiongetData()
Returns the paged results.Returns the identifiers of the data ingetData()
.protected void
setData
(List<TypedValue> data) Sets the paged resultsprotected void
setIdentifiers
(List<TypedValue> identifiers) Sets the the identifiers of the data ingetData()
.Methods inherited from class com.appiancorp.suiteapi.common.paging.DataSubset
getBatchSize, getSort, getStartIndex, getTotalCount, multilineToString, multilineToStringHelper, toString
-
Constructor Details
-
TypedValueDataSubset
public TypedValueDataSubset() -
TypedValueDataSubset
public TypedValueDataSubset(PagingInfo pagingInfo, int totalCount, List<TypedValue> data, List<TypedValue> identifiers) -
TypedValueDataSubset
public TypedValueDataSubset(int startIndex, int batchSize, List<SortInfo> sort, int totalCount, List<TypedValue> data, List<TypedValue> identifiers)
-
-
Method Details
-
getData
Returns the paged results.- Specified by:
getData
in classDataSubset<TypedValue,
TypedValue>
-
getIdentifiers
Returns the identifiers of the data ingetData()
. These are only unique if the underlying data source guarantees uniqueness.- Specified by:
getIdentifiers
in classDataSubset<TypedValue,
TypedValue>
-
setData
Sets the paged results- Specified by:
setData
in classDataSubset<TypedValue,
TypedValue> - Parameters:
data
- List ofTypedValue
results
-
setIdentifiers
Sets the the identifiers of the data ingetData()
.- Specified by:
setIdentifiers
in classDataSubset<TypedValue,
TypedValue> - Parameters:
identifiers
- List ofTypedValue
identifiers
-