Package com.evolveum.midpoint.prism.query

Interface ObjectPaging

All Superinterfaces:

DebugDumpable, Serializable

All Known Implementing Classes:

ObjectPagingImpl

public interface ObjectPaging
extends DebugDumpable, Serializable

Field Summary

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
void	addGroupingInstruction(ItemPath groupBy)
void	addOrderingInstruction(ItemPath orderBy, OrderDirection direction)
ObjectPaging	clone()
boolean	equals(Object o, boolean exact)
String	getCookie()	Returns the paging cookie.
ItemPath	getGroupBy()
List<? extends ObjectGrouping>	getGroupingInstructions()
Integer	getMaxSize()
Integer	getOffset()
List<? extends ObjectOrdering>	getOrderingInstructions()
ObjectGrouping	getPrimaryGrouping()
ObjectOrdering	getPrimaryOrdering()
OrderDirection	getPrimaryOrderingDirection()
ItemPath	getPrimaryOrderingPath()
boolean	hasCookie()
boolean	hasGrouping()
boolean	hasOrdering()
void	setCookie(String cookie)	Sets paging cookie.
void	setGrouping(ItemPath groupBy)
void	setGrouping(ObjectGrouping... groupings)
void	setGrouping(Collection<ObjectGrouping> groupings)
void	setMaxSize(Integer maxSize)
void	setOffset(Integer offset)
void	setOrdering(ItemPath orderBy, OrderDirection direction)
void	setOrdering(ObjectOrdering... orderings)
void	setOrdering(Collection<? extends ObjectOrdering> orderings)

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable

debugDump, debugDump, debugDumpLazily, debugDumpLazily

Method Detail

getPrimaryOrderingDirection

OrderDirection getPrimaryOrderingDirection()

getPrimaryOrderingPath

ItemPath getPrimaryOrderingPath()

getPrimaryOrdering

ObjectOrdering getPrimaryOrdering()

getGroupBy

ItemPath getGroupBy()

getPrimaryGrouping

ObjectGrouping getPrimaryGrouping()

getOrderingInstructions

List<? extends ObjectOrdering> getOrderingInstructions()

getGroupingInstructions

List<? extends ObjectGrouping> getGroupingInstructions()

hasOrdering

boolean hasOrdering()

setOrdering

void setOrdering(ItemPath orderBy,
                 OrderDirection direction)

hasGrouping

boolean hasGrouping()

hasCookie

boolean hasCookie()

setGrouping

void setGrouping(ItemPath groupBy)

addOrderingInstruction

void addOrderingInstruction(ItemPath orderBy,
                            OrderDirection direction)

setOrdering

void setOrdering(ObjectOrdering... orderings)

setOrdering

void setOrdering(Collection<? extends ObjectOrdering> orderings)

addGroupingInstruction

void addGroupingInstruction(ItemPath groupBy)

setGrouping

void setGrouping(ObjectGrouping... groupings)

setGrouping

void setGrouping(Collection<ObjectGrouping> groupings)

getOffset

Integer getOffset()

setOffset

void setOffset(Integer offset)

getMaxSize

Integer getMaxSize()

setMaxSize

void setMaxSize(Integer maxSize)

getCookie

String getCookie()

Returns the paging cookie. The paging cookie is used for optimization of paged searches. The presence of the cookie may allow the data store to correlate queries and associate them with the same server-side context. This may allow the data store to reuse the same pre-computed data. We want this as the sorted and paged searches may be quite expensive. It is expected that the cookie returned from the search will be passed back in the options when the next page of the same search is requested. It is OK to initialize a search without any cookie. If the datastore utilizes a re-usable context it will return a cookie in a search response.

setCookie

void setCookie(String cookie)

Sets paging cookie. The paging cookie is used for optimization of paged searches. The presence of the cookie may allow the data store to correlate queries and associate them with the same server-side context. This may allow the data store to reuse the same pre-computed data. We want this as the sorted and paged searches may be quite expensive. It is expected that the cookie returned from the search will be passed back in the options when the next page of the same search is requested. It is OK to initialize a search without any cookie. If the datastore utilizes a re-usable context it will return a cookie in a search response.

clone

ObjectPaging clone()

equals

boolean equals(Object o,
               boolean exact)