Documentation

ListReturnType
in package

ListReturnType determines the returned values in CDT List operations.

Table of Contents

Methods

count()  : ListReturnType
ListReturnTypeCount will return count of items selected.
Exists()  : ListReturnType
ListReturnTypeExists returns true if count > 0.
Index()  : ListReturnType
ListReturnTypeIndex will return index offset order.
inverted()  : ListReturnType
ListReturnTypeInverted will invert meaning of list command and return values. For example: ListOperation.getByIndexRange(binName, index, count, ListReturnType.INDEX | ListReturnType.INVERTED) With the INVERTED flag enabled, the items outside of the specified index range will be returned.
None()  : ListReturnType
ListReturnTypeNone will not return a result.
Rank()  : ListReturnType
ListReturnTypeRank will return value order.
ReverseIndex()  : ListReturnType
ListReturnTypeReverseIndex will return reverse index offset order.
ReverseRank()  : ListReturnType
ListReturnTypeReverseRank will return reverse value order.
Value()  : ListReturnType
ListReturnTypeValue will return value for single key read and value list for range read.

Methods

inverted()

ListReturnTypeInverted will invert meaning of list command and return values. For example: ListOperation.getByIndexRange(binName, index, count, ListReturnType.INDEX | ListReturnType.INVERTED) With the INVERTED flag enabled, the items outside of the specified index range will be returned.

public inverted() : ListReturnType

The meaning of the list command can also be inverted. For example: ListOperation.removeByIndexRange(binName, index, count, ListReturnType.INDEX | ListReturnType.INVERTED); With the INVERTED flag enabled, the items outside of the specified index range will be removed and returned.

Return values
ListReturnType

        
On this page

Search results