Package ru.tinkoff.qa.neptune.hibernate.select.common

Class SelectAsPageStepSupplier<R>

java.lang.Object

ru.tinkoff.qa.neptune.core.api.steps.SequentialGetStepSupplier<T,R,M,P,THIS>

ru.tinkoff.qa.neptune.core.api.steps.SequentialGetStepSupplier.GetListStepSupplier<HibernateContext,Iterable<R>,R,SelectManyStepSupplier<R>>

ru.tinkoff.qa.neptune.hibernate.select.SelectManyStepSupplier<R>

ru.tinkoff.qa.neptune.hibernate.select.common.SelectAsPageStepSupplier<R>

All Implemented Interfaces:

Cloneable, Supplier<Function<HibernateContext,List<R>>>, StepParameterPojo, SelectQuery<List<R>>

public abstract class SelectAsPageStepSupplier<R>
extends SelectManyStepSupplier<R>

Nested Class Summary

Nested classes/interfaces inherited from class ru.tinkoff.qa.neptune.core.api.steps.SequentialGetStepSupplier

SequentialGetStepSupplier.DefaultGetParameterReader, SequentialGetStepSupplier.DefineCriteriaParameterName, SequentialGetStepSupplier.DefineFromParameterName, SequentialGetStepSupplier.DefineGetImperativeParameterName, SequentialGetStepSupplier.DefinePollingTimeParameterName, SequentialGetStepSupplier.DefineResultDescriptionParameterName, SequentialGetStepSupplier.DefineTimeOutParameterName, SequentialGetStepSupplier.GetArrayChainedStepSupplier<T,R,M,THIS extends SequentialGetStepSupplier.GetArrayChainedStepSupplier<T,R,M,THIS>>, SequentialGetStepSupplier.GetArrayStepSupplier<T,R,THIS extends SequentialGetStepSupplier.GetArrayStepSupplier<T,R,THIS>>, SequentialGetStepSupplier.GetListChainedStepSupplier<T,S extends Iterable<R>,M,R,THIS extends SequentialGetStepSupplier.GetListChainedStepSupplier<T,S,M,R,THIS>>, SequentialGetStepSupplier.GetListStepSupplier<T,S extends Iterable<R>,R,THIS extends SequentialGetStepSupplier.GetListStepSupplier<T,S,R,THIS>>, SequentialGetStepSupplier.GetObjectChainedStepSupplier<T,R,M,THIS extends SequentialGetStepSupplier.GetObjectChainedStepSupplier<T,R,M,THIS>>, SequentialGetStepSupplier.GetObjectFromArrayChainedStepSupplier<T,R,M,THIS extends SequentialGetStepSupplier.GetObjectFromArrayChainedStepSupplier<T,R,M,THIS>>, SequentialGetStepSupplier.GetObjectFromArrayStepSupplier<T,R,THIS extends SequentialGetStepSupplier.GetObjectFromArrayStepSupplier<T,R,THIS>>, SequentialGetStepSupplier.GetObjectFromIterableChainedStepSupplier<T,R,M,THIS extends SequentialGetStepSupplier.GetObjectFromIterableChainedStepSupplier<T,R,M,THIS>>, SequentialGetStepSupplier.GetObjectFromIterableStepSupplier<T,R,THIS extends SequentialGetStepSupplier.GetObjectFromIterableStepSupplier<T,R,THIS>>, SequentialGetStepSupplier.GetObjectStepSupplier<T,R,THIS extends SequentialGetStepSupplier.GetObjectStepSupplier<T,R,THIS>>, SequentialGetStepSupplier.GetSimpleStepSupplier<T,R,THIS extends SequentialGetStepSupplier.GetSimpleStepSupplier<T,R,THIS>>

Field Summary

Fields inherited from class ru.tinkoff.qa.neptune.core.api.steps.SequentialGetStepSupplier

toReport

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SelectAsPageStepSupplier(SelectionAsPage<R> select)

Method Summary

Modifier and Type	Method	Description
SelectAsPageStepSupplier<R>	limit(int limit)
SelectAsPageStepSupplier<R>	offset(int offset)
protected void	onStart(HibernateContext context)	Some additional action on start of the getting step-function
SelectAsPageStepSupplier<R>	order(List<javax.persistence.criteria.Order> orders)
SelectAsPageStepSupplier<R>	order(javax.persistence.criteria.Order... orders)
default THIS	returnAfterIndex(int index)	Sets lower list index (exclusively) to take items from the list of found/suitable elements.
default THIS	returnBeforeIndex(int index)	Sets upper list index (exclusively) to take items from the list of found/suitable elements.
default THIS	returnIfEntireSize(ItemsCountCondition sizeCondition)	Defines a size condition for entire list of found/suitable elements.
default THIS	returnItemsOfIndexes(Integer... indexes)	Defines indexes of found items to be returned.
default THIS	returnListOfSize(int size)	Sets count of items to take from the list of found/suitable elements.
default THIS	returnOnCondition(String description, Predicate<T> predicate)	Defines a condition for entire set of found/suitable elements.
default THIS	returnOnCondition(Criteria<List<R>> condition)	Defines a condition for list of found/suitable elements.
default THIS	returnOnConditionOnlyNot(Criteria<T>... condition)	Defines a condition for entire set of found/suitable elements.
default THIS	returnOnConditionOnlyOne(Criteria<T>... condition)	Defines a condition for entire set of found/suitable elements.
default THIS	returnOnConditionOr(Criteria<T>... condition)	Defines a condition for entire set of found/suitable elements.

Methods inherited from class ru.tinkoff.qa.neptune.hibernate.select.SelectManyStepSupplier

pollingInterval, setDescription, thenGetIterable, thenGetIterableItem, thenGetList, timeOut

Methods inherited from class ru.tinkoff.qa.neptune.core.api.steps.SequentialGetStepSupplier

addIgnored, addIgnored, additionalParameters, eraseTimeOut, getCriteria, getDescription, getEndFunction, getFrom, getParameters, makeACopy, onFailure, onSuccess, preparePreFunction, throwOnNoResult, toString, turnReportingOff

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectAsPageStepSupplier

protected SelectAsPageStepSupplier(SelectionAsPage<R> select)

Method Detail

limit

public SelectAsPageStepSupplier<R> limit(int limit)

offset

public SelectAsPageStepSupplier<R> offset(int offset)

order

public SelectAsPageStepSupplier<R> order(List<javax.persistence.criteria.Order> orders)

order

public SelectAsPageStepSupplier<R> order(javax.persistence.criteria.Order... orders)

onStart

protected void onStart(HibernateContext context)

Description copied from class: SequentialGetStepSupplier

Some additional action on start of the getting step-function

Overrides:

onStart in class SequentialGetStepSupplier<HibernateContext,List<R>,HibernateContext,R,SelectManyStepSupplier<R>>

Parameters:

context - is a mediator value is used to get the required result

returnListOfSize

public default THIS returnListOfSize(int size)

Sets count of items to take from the list of found/suitable elements. Invocation of this method erases value set by returnItemsOfIndexes(Integer...)

Parameters:

size - size of resulted list

Returns:

self-reference

returnItemsOfIndexes

public default THIS returnItemsOfIndexes(Integer... indexes)

Defines indexes of found items to be returned. Invocation of this method erases value set by returnListOfSize(int) and returnBeforeIndex(int) / returnAfterIndex(int)

Parameters:

indexes - indexes of items to be returned

Returns:

self-reference

returnBeforeIndex

public default THIS returnBeforeIndex(int index)

Sets upper list index (exclusively) to take items from the list of found/suitable elements. Invocation of this method replaces value set by returnAfterIndex(int) and erases value set by returnItemsOfIndexes(Integer...)

Parameters:

index - is exclusive value of the upper index

Returns:

self-reference

returnAfterIndex

public default THIS returnAfterIndex(int index)

Sets lower list index (exclusively) to take items from the list of found/suitable elements. Invocation of this method replaces value set by returnBeforeIndex(int) and erases value set by returnItemsOfIndexes(Integer...)

Parameters:

index - is exclusive value of the lower index

Returns:

self-reference

returnIfEntireSize

public default THIS returnIfEntireSize(ItemsCountCondition sizeCondition)

Defines a size condition for entire list of found/suitable elements.

Parameters:

sizeCondition - a size condition for entire list

Returns:

self-reference

returnOnCondition

public default THIS returnOnCondition(Criteria<List<R>> condition)

Defines a condition for list of found/suitable elements.

Parameters:

condition - a condition for entire list

Returns:

self-reference

returnOnCondition

public default THIS returnOnCondition(String description,
                                      Predicate<T> predicate)

Defines a condition for entire set of found/suitable elements.

Parameters:

description - describes the condition

predicate - defines the condition

Returns:

self-reference

returnOnConditionOr

public default THIS returnOnConditionOr(Criteria<T>... condition)

Defines a condition for entire set of found/suitable elements. Defined criteria will be transformed into OR-expression

Parameters:

condition - condition for entire set of items

Returns:

self-reference

returnOnConditionOnlyOne

public default THIS returnOnConditionOnlyOne(Criteria<T>... condition)

Defines a condition for entire set of found/suitable elements. Defined criteria will be transformed into XOR-expression

Parameters:

condition - condition for entire set of items

Returns:

self-reference

returnOnConditionOnlyNot

public default THIS returnOnConditionOnlyNot(Criteria<T>... condition)

Defines a condition for entire set of found/suitable elements. Defined criteria will be inverted

Parameters:

condition - condition for entire set of items

Returns:

self-reference