ch.postfinance.sdk.model

Class EntityQuery

java.lang.Object

ch.postfinance.sdk.model.EntityQuery

public class EntityQuery
extends Object

The entity query allows to search for specific entities by providing filters. This is similar to a SQL query.

Field Summary

Fields

Modifier and Type	Field and Description
protected EntityQueryFilter	filter
protected String	language
protected Integer	numberOfEntities
protected List<EntityQueryOrderBy>	orderBys
protected Integer	startingEntity

Constructor Summary

Constructors

Constructor and Description
EntityQuery()

Method Summary

Modifier and Type	Method and Description
EntityQuery	addOrderBysItem(EntityQueryOrderBy orderBysItem)
boolean	equals(Object o)
EntityQuery	filter(EntityQueryFilter filter)
EntityQueryFilter	getFilter() The filter node defines the root filter node of the query.
String	getLanguage() The language is applied to the ordering of the entities returned.
Integer	getNumberOfEntities() The number of entities defines how many entities should be returned.
List<EntityQueryOrderBy>	getOrderBys() The order bys allows to define the ordering of the entities returned by the search.
Integer	getStartingEntity() The 'starting entity' defines the entity number at which the returned result should start.
int	hashCode()
EntityQuery	language(String language)
EntityQuery	numberOfEntities(Integer numberOfEntities)
EntityQuery	orderBys(List<EntityQueryOrderBy> orderBys)
void	setFilter(EntityQueryFilter filter)
void	setLanguage(String language)
void	setNumberOfEntities(Integer numberOfEntities)
void	setOrderBys(List<EntityQueryOrderBy> orderBys)
void	setStartingEntity(Integer startingEntity)
EntityQuery	startingEntity(Integer startingEntity)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

filter

protected EntityQueryFilter filter

language

protected String language

numberOfEntities

protected Integer numberOfEntities

orderBys

protected List<EntityQueryOrderBy> orderBys

startingEntity

protected Integer startingEntity

Constructor Detail

EntityQuery

public EntityQuery()

Method Detail

filter

public EntityQuery filter(EntityQueryFilter filter)

getFilter

public EntityQueryFilter getFilter()

The filter node defines the root filter node of the query. The root node may contain multiple sub nodes with different filters in it.

Returns:

filter

setFilter

public void setFilter(EntityQueryFilter filter)

language

public EntityQuery language(String language)

getLanguage

public String getLanguage()

The language is applied to the ordering of the entities returned. Some entity fields are language dependent and hence the language is required to order them.

Returns:

language

setLanguage

public void setLanguage(String language)

numberOfEntities

public EntityQuery numberOfEntities(Integer numberOfEntities)

getNumberOfEntities

public Integer getNumberOfEntities()

The number of entities defines how many entities should be returned. There is a maximum of 100 entities.

Returns:

numberOfEntities

setNumberOfEntities

public void setNumberOfEntities(Integer numberOfEntities)

orderBys

public EntityQuery orderBys(List<EntityQueryOrderBy> orderBys)

addOrderBysItem

public EntityQuery addOrderBysItem(EntityQueryOrderBy orderBysItem)

getOrderBys

public List<EntityQueryOrderBy> getOrderBys()

The order bys allows to define the ordering of the entities returned by the search.

Returns:

orderBys

setOrderBys

public void setOrderBys(List<EntityQueryOrderBy> orderBys)

startingEntity

public EntityQuery startingEntity(Integer startingEntity)

getStartingEntity

public Integer getStartingEntity()

The 'starting entity' defines the entity number at which the returned result should start. The entity number is the consecutive number of the entity as returned and it is not the entity id.

Returns:

startingEntity

setStartingEntity

public void setStartingEntity(Integer startingEntity)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object