Interface: FetchByOffsetParameters

Fields

filterCriterion :oj.FilterOperator

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Optional filter criterion to apply. The filter criterion would be composed of a supported FilterOperator such as a AttributeFilterOperator or a CompoundFilterOperator.

Since:

• 4.1.0

Inherited From:

• oj.FetchListParameters#filterCriterion

Example

The following would be a valid filterCriterion:
{op: '$or', criteria: [{op: '$eq', attribute: 'name', value: 'Bob'}, {op: '$gt', attribute: 'level', value: 'Low'}]}

offset :number

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

The offset used for the fetch call.

Since:

• 4.1.0

size :number

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Optional number of rows to fetch starting from offset. If fewer than that number of rows exist, the fetch will succeed but be truncated.

Since:

• 4.1.0

Inherited From:

• oj.FetchListParameters#size

sortCriteria :Array.<oj.SortCriterion>

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Optional sort criteria to apply.

Since:

• 4.1.0

Inherited From:

• oj.FetchListParameters#sortCriteria